Agentready Mcp

@agentreadyweb/mcp

什么是 AgentReady？

AgentReady 是一个托管能力层，通过 MCP 让 Agent 能够发现和使用任何网站。

粘贴一个 URL → AgentReady 会抓取网站，生成符合规范的 llms.txt，并托管一个实时的 /ask RAG 端点和 MCP 服务。之后，任何兼容 MCP 的 Agent 客户端都可以发现该网站、提出自然语言问题、检查其能力，并创建有引用依据的只读计划。

它解决的问题： 使用 web_fetch 的 AI Agent 一次只能抓取一个页面，遇到 JavaScript 单页应用（React、Next.js、Vue）时会得到空 HTML；当答案涉及多个页面时，还会产生幻觉。AgentReady 会为整个网站建立索引、处理 JS 渲染，并跨页面检索，让 Agent 获得正确答案，而不是自信地给出错误答案。

已建立索引的内容： 浏览实时的 AgentReady 目录 →，也可以自行索引任何公开网站。

主要特性：

• 适用于任何公开 URL — 静态网站、React/Next.js 单页应用、Docusaurus、GitBook、自定义引擎
• 首次索引网站无需账号
• 共享索引 — 一名团队成员提交网站后，团队中的所有人都可以立即查询
• 可处理 web_fetch 返回空内容的 JS 渲染页面
• 能力清单会公开数据新鲜度、架构、端点和只读限制
• 有依据的计划会返回证据、风险、确认要求和持久化回执

CLI

同一软件包也可用作 CLI — 无需安装，无需账号：

# Agent-readiness report card (llms.txt, sitemap, robots, JS-rendering, index status)
npx @agentreadyweb/mcp grade yourdocs.com

# Ask any site a question, get a cited answer (auto-indexes new sites in ~60s)
npx @agentreadyweb/mcp ask stripe.com "what is the test card number?"

# Index or re-crawl a site
npx @agentreadyweb/mcp index yourdocs.com
npx @agentreadyweb/mcp refresh yourdocs.com

对于 CI、仪表板或脚本，添加 --json，即可在 stdout 中接收原始报告 （进度信息仍会输出到 stderr）：

npx @agentreadyweb/mcp grade yourdocs.com --json | jq '.grade, .score'

如果评分低于 B，该命令仍会以 1 退出。

grade 在评分低于 B 时会以非零状态退出，因此你可以将其用作 CI 检查门槛。在文档部署流水线中使用 refresh，即可自动保持索引最新：

# GitHub Actions — after your docs deploy step
- run: npx @agentreadyweb/mcp refresh yourdocs.com

---

将任何兼容 MCP 的客户端连接到 AgentReady：

本地 MCP 桥接（stdio）

对于使用 mcpServers 配置的客户端，添加 AgentReady 桥接：

{
  "mcpServers": {
    "agentready": {
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

重启客户端。随后即可使用八个工具：

• list_sites — 查看所有已建立索引的网站
• get_site_capabilities — 按需建立索引，然后检查网站清单、数据新鲜度、架构和端点
• get_site_facts — 获取从网站提取的关键结构化事实
• ask_site — 查询任意网站，获取带引用的多页面答案
• plan_site_action — 按需建立索引，然后创建有依据的只读计划和回执
• submit_site — 为任意网站建立索引，以便查询
• refresh_site — 重新抓取网站，或为新网站执行首次索引
• rate_answer — 提交答案质量反馈

Cursor

添加到 ~/.cursor/mcp.json：

{
  "agentready": {
    "command": "npx",
    "args": ["-y", "@agentreadyweb/mcp"]
  }
}

项目或终端配置

npx @agentreadyweb/mcp

也可以将同一个 agentready 服务添加到客户端的项目配置中，与团队共享：

{
  "mcpServers": {
    "agentready": {
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

VS Code（GitHub Copilot Agent 模式）

需要 VS Code 1.99+ 和 GitHub Copilot 扩展。在项目根目录中创建 .vscode/mcp.json：

{
  "servers": {
    "agentready": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

Copilot 的 MCP 工具仅在 Agent 模式下可用。提交此文件即可与团队共享。

Windsurf / Zed / 其他客户端

任何支持 stdio 传输的 MCP 客户端都可以使用相同方式 — 将 npx -y @agentreadyweb/mcp 用作命令。

WebMCP（无需安装）

如果客户端支持 HTTP 传输，可直接通过 URL 连接 — 无需 npm：

https://www.agentready.it.com/api/mcp

Docusaurus 插件

如果文档网站使用 Docusaurus，可在每次构建时自动建立索引：

npm install @agentreadyweb/docusaurus-plugin

// docusaurus.config.js
plugins: [
  ['@agentreadyweb/docusaurus-plugin', { domain: 'docs.yoursite.com' }]
]

MkDocs 插件

如果文档网站使用 MkDocs，可在每次构建时自动建立索引：

pip install mkdocs-agentready

# mkdocs.yml
plugins:
  - search
  - agentready

如果未设置 site_url，请明确指定域名：

plugins:
  - agentready:
      domain: docs.yoursite.com

Starlight 插件

如果你的文档站点使用 Starlight（Astro），则每次构建时自动建立索引：

npm install starlight-agentready

// astro.config.mjs
import agentready from 'starlight-agentready'

export default defineConfig({
  site: 'https://docs.yoursite.com',
  integrations: [
    starlight({
      plugins: [agentready()],
    }),
  ],
})

Sphinx 扩展

如果你的文档站点使用 Sphinx，则每次构建时自动建立索引：

pip install sphinx-agentready

# conf.py
extensions = [
    "sphinx_agentready.extension",
]

# Domain is inferred from html_baseurl automatically, or set explicitly:
agentready_domain = "docs.yoursite.com"

可用工具

list_sites

列出 AgentReady 当前已建立索引的所有网站及其标题和页面数量。提交网站前，可用此工具检查该域名是否已可用。

get_site_capabilities

get_site_capabilities(domain: string)

返回网站的能力清单、最新状态、架构以及可用的 HTTP/MCP 端点。

get_site_facts

get_site_facts(domain: string)

返回从网站提取的关键结构化事实，例如定价层级、功能列表、限制以及 Agent 常需了解的其他高价值信息。

plan_site_action

plan_site_action(domain: string, request: string)

创建一份基于证据的只读计划，其中包含风险、确认要求和持久化回执。不会执行副作用。

submit_site

submit_site(url: string)

使用 AgentReady 为任意网站建立索引。耗时约 60 秒。通过四层处理流程支持静态网站、服务器渲染页面和 JavaScript 密集型 SPA。完成后，可使用 ask_site 查询。

示例： submit_site("https://docs.example.com")

ask_site

ask_site(domain: string, query: string, url?: string)

针对任意网站提问，并获取基于网站内容且附有引用的回答。综合多个页面的信息。如果网站尚未建立索引，AgentReady 会在回答前自动抓取并建立索引（约 60 秒）。

示例： ask_site("stripe.com", "What are the fees for card payments?")

refresh_site

refresh_site(domain: string)

强制重新完整抓取网站，以获取新增或变更的内容。如果是新网站，AgentReady 会自动为其建立初始索引。耗时约 60 秒。

示例： refresh_site("docs.example.com")

rate_answer

rate_answer(domain: string, rating: number, request_id?: string, comment?: string)

提交 1–5 分的质量反馈，可选关联到确切的 ask_site 请求。

部署 Webhook

每次部署时自动重新建立文档索引。无需身份验证——每个域名每小时最多限流一次。

curl -X POST https://www.agentready.it.com/api/webhook/refresh \
  -H "Content-Type: application/json" \
  -d '{"domain": "docs.yoursite.com"}'

也可以将域名作为查询参数传入（适用于使用表单编码 Webhook 负载的 Vercel/Netlify）：

https://www.agentready.it.com/api/webhook/refresh?domain=docs.yoursite.com

索引的工作原理

AgentReady 采用分层方法处理任意公开网站：

1. llms.txt / llms-full.txt — 如果网站发布了这类文件，就会将其用作高质量的结构化内容来源
2. 标准 HTML 抓取 — 通过站点地图或链接抓取最多 10 个页面，并提取干净的文本
3. __NEXT_DATA__ 提取 — 对于 Next.js 应用，会解析嵌入 HTML 中的服务器端渲染数据
4. Jina Reader 回退方案 — 对于返回空 HTML 的纯 JS SPA，使用远程渲染服务提取内容

需要身份验证或没有公开 HTML 内容的网站无法建立索引。

环境变量

变量	默认值	描述
AGENTREADY_MCP_URL	https://www.agentready.it.com/api/mcp	覆盖 MCP 端点（用于可自托管部署）
AGENTREADY_TELEMETRY	1	设置为 0 可停用匿名使用情况遥测

遥测

每次 MCP 桥接启动或运行 CLI 命令时，此软件包都会向 agentready.it.com/api/telemetry 发送轻量级匿名 ping。包含：随机安装 ID（存储在 ~/.agentready/install-id）、软件包版本、Node 版本、平台以及所用模式/命令。不包含查询内容、域名或个人数据。设置 AGENTREADY_TELEMETRY=0 即可选择退出。