agent-ready-scanner

中文文档
0.6.2发布于 2026/11/03MITES Module零依赖

代理就绪的命令行客户端-扫描任何URL的ai可读性针对Vercel代理可读性规范,llmstxt.org标准,和代理协议清单。包装agent-ready.dev REST API。

中文使用文档
文档目录14 节
  1. 安装
  2. 身份验证
  3. 命令
  4. scan <url>
  5. get <id>
  6. list
  7. ask <query...>
  8. mcp-scan <endpoint>
  9. validate-schema <url|->
  10. 全局选项
  11. 环境变量
  12. 退出代码
  13. 开发
  14. 许可证

agent-ready-scanner

命令行客户端 代理准备好了 -扫描任何URL AI-agent可读性 与Vercel代理可读性规范的 llmstxt.org 标准和代理协议清单(MCP服务器卡,A2A, agents.json, agent-permissions.json, UCP, x402, NLWeb),加上一个单独的可访问性子评分(WCAG 2.2 /布局稳定性)。

它是宿主的一个薄包装器 dev REST API -本地不扫描。有关AI助手的工具原生访问,请参见 agent-ready-mcp 代替。

安装

npm install -g agent-ready-scanner

这将安装 agent-ready 命令。或运行不安装:

npx agent-ready-scanner scan https://example.com

为什么 agent-ready-scanner? 裸露的 agent-ready 名称被 Npm的包名相似策略(它与不相关的 agentready 包)。已安装的命令是静止的 agent-ready.

要求Node.js≥20.10。

身份验证

scan 作品 没有钥匙 关于免费匿名3级扫描每30次 每个IP, 25页深度:

npx agent-ready-scanner scan https://example.com   # no key, no account

一、 Pro API密钥 解锁50扫描/月,250页深度,扫描历史 (get, list),以及每周监测。从 指示板,然后:

export AGENT_READY_API_KEY="ar_live_..."
# or pass per-command:
agent-ready scan https://example.com --api-key ar_live_...

ask, mcp-scan, validate-schema 是公开的,不需要钥匙。

命令

scan <url>

启动扫描,等待扫描完成,并打印可读性摘要。 无键运行使用匿名免费层(同步,25页);用Pro 键,扫描在具有轮询的更深层身份验证管道上运行。

agent-ready scan https://example.com
agent-ready scan https://example.com --page-limit 25
agent-ready scan https://example.com --no-wait      # queue only, print the id
agent-ready scan https://example.com --json         # raw JSON
选项描述
--page-limit <n>可抓取的最大页面数
--no-wait将扫描排队,并在不轮询的情况下打印其id
--poll-interval <s>状态轮询之间的秒数(默认为2)
--timeout <s>等待完成的最大秒数(默认为120秒)

get <id>

通过id获取扫描(例如,先前以 --no-wait)。

agent-ready get V1StGXR8_Z
agent-ready get V1StGXR8_Z --json

list

列出你最近的扫描结果,最新的放在第一位。

agent-ready list
agent-ready list --limit 5
agent-ready list --cursor 2026-05-30T00:00:00.000Z   # next page

ask <query...>

用自然语言搜索雷迪探员自己的文件(方法,检查) 注册表,支持的规格)。公共-没有API密钥。

agent-ready ask "how is the score calculated?"
agent-ready ask "what does check S4 do?" --type checks
agent-ready ask "summarize the llms.txt requirements" --mode summarize

mcp-scan <endpoint>

连接到一个实时的、远程托管的MCP服务器,并对其工具、资源、 并提示MCP最佳实践-返回0-100 MCP质量分数 每个问题的修复。公共-没有API密钥。非常适合CI(例如,当构建失败时) 您的服务器得分低于阈值)。仅限远程http(s)端点。

agent-ready mcp-scan https://mcp.example.com/mcp
agent-ready mcp-scan https://mcp.example.com/mcp --json

validate-schema <url|->

验证页面的JSON-LD结构化数据模式lint和代理一致性 检查第一方验证器(validator.schema.org, Rich Results Test) 不做(新鲜、诚实、规范).md 一致性,实体名称一致性, 提取信号)。传递一个URL来获取和验证,或者 - 读取JSON-LD 字符串从stdin(粘贴模式-方便验证JSON-LD代理只是 已编写,不需要部署)。公共-没有API密钥。在任何检查时退出非零 失败了,所以它进入了CI。

agent-ready validate-schema https://example.com/product
cat page.jsonld | agent-ready validate-schema -
echo '{"@context":"https://schema.org","@type":"Product","name":"X"}' \
  | agent-ready validate-schema - --json

全局选项

选项描述
--json输出原始JSON而不是格式化文本
--api-key <key>覆盖 AGENT_READY_API_KEY
--base-url <url>覆盖 AGENT_READY_API_URL (例如本地开发)
--no-color禁用彩色输出(NO_COLOR 也很荣幸)
-h, --help显示帮助
-v, --version显示版本

环境变量

变量默认的目的
AGENT_READY_API_KEY- - - - - -需要Pro API密钥 get/list,可选 scan (无密钥运行在匿名层)
AGENT_READY_API_URLhttps://agent-ready.devAPI基础URL
AGENT_READY_SCAN_TIMEOUT_MS120000总体扫描等待预算
AGENT_READY_GET_TIMEOUT_MS10000每个请求超时

退出代码

代码意义
0成功
1API错误、扫描失败或扫描超时
2使用错误(错误参数)

--json 输出到stdout;进步和错误都归于错误,所以你可以 安全地将JSON管道到其他工具。

开发

npm install
npm test          # vitest
npm run typecheck # tsc --noEmit
npm run build     # bundle to dist/cli.mjs

许可证

MIT©Agent Ready

版本与发布记录

agent-ready-scanner 共发布 12 个版本,首次发布于 2026/05/31;过去 12 个月发布了 12 个版本。

版本发布日期距今
0.6.2latest2026/11/03今天
0.6.12026/07/313 个月前
0.6.02026/07/273 个月前
0.5.22026/07/203 个月前
0.5.12026/07/203 个月前
0.5.02026/07/183 个月前

关于 agent-ready-scanner 的常见问题

agent-ready-scanner 是什么?

代理就绪的命令行客户端-扫描任何URL的ai可读性针对Vercel代理可读性规范,llmstxt.org标准,和代理协议清单。包装agent-ready.dev REST API。

如何安装 agent-ready-scanner?

在项目目录运行 npm install agent-ready-scanner,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 agent-ready,可以用 npx agent-ready 直接运行。

agent-ready-scanner 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/agent-ready-scanner 是否存在。

agent-ready-scanner 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

agent-ready-scanner 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.10。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

agent-ready-scanner 可以商用吗?

agent-ready-scanner 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

agent-ready-scanner 还在维护吗?

最新版本 0.6.2 发布于 2026/11/03(今天);至今共发布 12 个版本,其中过去 12 个月发布了 12 个;首次发布于 2026/05/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。