# agent-ready-scanner 中文文档

规范地址：https://npmcn.com/package/agent-ready-scanner/

版本：0\.6\.2
npm 元数据更新时间：2026-11-03T01:58:18.656Z
中文译文更新时间：2026-11-03T02:04:57.380Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/agent-ready-scanner
原文对照：https://npmcn.com/package/agent-ready-scanner/?lang=original
项目主页：https://agent-ready.dev/
源码仓库：https://github.com/mlava/agent-ready-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：38.8 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.10
- 运行依赖：0 个
- 首次发布：2026-05-31T00:37:12.780Z
- 最新版本发布：2026-11-03T01:58:18.502Z
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

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

## 安装

```sh
npm install agent-ready-scanner
```

也可以使用：`pnpm add agent-ready-scanner`、`yarn add agent-ready-scanner`、`bun add agent-ready-scanner`

## README

# agent-ready-scanner

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

它是宿主的一个薄包装器 [dev REST API](https://agent-ready.dev/api/v1/openapi.json) -本地不扫描。有关AI助手的工具原生访问，请参见 [`agent-ready-mcp`](https://github.com/mlava/agent-ready-mcp) 代替。

## 安装

```bash
npm install -g agent-ready-scanner
```

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

```bash
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页深度：

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

一、 **Pro API密钥** 解锁50扫描/月，250页深度，扫描历史 （`get`， `list`)，以及每周监测。从 [指示板](https://agent-ready.dev/dashboard/api-keys)，然后：

```bash
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 键，扫描在具有轮询的更深层身份验证管道上运行。

```bash
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`）。

```bash
agent-ready get V1StGXR8_Z
agent-ready get V1StGXR8_Z --json
```

### `list`

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

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

### `ask <query...>`

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

```bash
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)端点。

```bash
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。

```bash
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`](https://no-color.org/) 也很荣幸) |
| `-h, --help` | 显示帮助 |
| `-v, --version` | 显示版本 |

## 环境变量

| 变量 | 默认的 | 目的 |
| --- | --- | --- |
| `AGENT_READY_API_KEY` | \- - - - - - | 需要Pro API密钥 `get`/`list`，可选 `scan` （无密钥运行在匿名层） |
| `AGENT_READY_API_URL` | `https://agent-ready.dev` | API基础URL |
| `AGENT_READY_SCAN_TIMEOUT_MS` | `120000` | 总体扫描等待预算 |
| `AGENT_READY_GET_TIMEOUT_MS` | `10000` | 每个请求超时 |

## 退出代码

| 代码 | 意义 |
| --- | --- |
| `0` | 成功 |
| `1` | API错误、扫描失败或扫描超时 |
| `2` | 使用错误（错误参数） |

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

## 开发

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

## 许可证

MIT©Agent Ready

## 常见问题

### 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 和提交记录判断。