ai-readiness

<p align="center"> <a href="https://ai.silverbackmarketing.com"><img src="https://ai.silverbackmarketing.com/images/ai-readiness-og.jpg" alt="AI 准备文件 — 一套结构化的文件，告诉 ChatGPT、Claude、Gemini 和 Perplexity 确切的您是谁，以免他们猜错" width="100%"></a> </p> # AI 准备技能 [](https://www.npmjs.com/package/@silverbackmarketing/ai-readiness) [](https://www.npmjs.com/package/@silverbackmarketing/ai-readiness) [](LICENSE) [](https://ai.silverbackmarketing.com/#mcp) [](https://ai.silverbackmarketing.com) > 生成完整的 **AI 准备文件套件** （GEO / 生成引擎优化）用于任何网站，只需一个命令 — `llms.txt`、`ai.txt`、模式、RAG 索引等。将其安装到 Claude、Cursor、Windsurf、GitHub Copilot、Gemini 或 Codex，只需一个 `npx` 命令，或通过 MCP 连接，无需安装。 **📖 现场站点和完整文档：** **[ai.silverbackmarketing.com](https://ai.silverbackmarketing.com)** · ⭐ 如果它帮助您被 AI 找到，请给此仓库点赞。 --- ## 什么是 AI 准备工具包？ AI 准备工具包是一套免费、开源的 **17 个结构化文件** ，您可以在网站根目录部署这些文件 — `robots.txt`、`ai.txt`、`llms.txt`、模式、RAG 索引等 — 它们可以准确地告诉 ChatGPT、Claude、Gemini 和 Perplexity 您是谁、您提供什么以及如何代表您。只需一个命令即可生成适用于任何网站的整个文件套件。永久免费（MIT）；使用 `npx` 安装或通过 MCP 运行，无需安装。 --- ## 为什么 AI 准备很重要 当有人想要产品推荐、服务提供商或直接答案时，他们通常会在访问网站之前询问 ChatGPT、Claude、Gemini 或 Perplexity。 如果您没有向这些系统提供清晰、当前的信息，他们会猜测 — 而且他们经常猜错。 AI 准备文件是在网站根目录部署的结构化文件，用于准确地告诉 AI 系统 **您是谁、您提供什么以及在哪里发送用户**。它们采用 AI 已经理解的格式（ [llmstxt.org](https://llmstxt.org) 标准、Schema.org 和新兴的 AI 爬虫约定），因此助手不再根据过时的训练数据猜测您的品牌，而是在他们的答案中准确地代表您。 该技能研究任何网站，分类其行业，并为您的网站生成所有这些文件 — 在一个命令中量身定制。 --- ## 目录 - [安装](#安装) - [通过 MCP 使用（无需安装）](#通过-mcp-使用无需安装) - [它做什么](#它做什么) - [文件](#文件) - [用法](#用法) - [常见问题](#常见问题) - [参考文档](#参考文档) - [PDF 指南](#pdf-指南) - [技能文件结构](#技能文件结构) - [作者和公司](#作者和公司) - [许可证](#许可证) --- ## 安装 ### 快速安装（任意代理）— `npx` ```bash # 全局技能安装 → ~/.agents/skills/ 和 ~/.claude/skills/ （默认） npx @silverbackmarketing/ai-readiness install # AGENTS.md — 跨代理标准（Cursor、Codex 等） npx @silverbackmarketing/ai-readiness install --agent agents # 两者同时（推荐） npx @silverbackmarketing/ai-readiness install --all ``` 主要目标： | 目标 | 安装到 | |---|---| | `skills` | `~/.agents/skills/ai-readiness/` **和** `~/.claude/skills/ai-readiness/` （完整技能 — `SKILL.md` + 脚本 + 参考） | | `agents` | `./AGENTS.md` — Cursor、Codex 和越来越多的代理阅读的标准（添加一个分隔块，保持现有内容） | | `claude` | 仅 `~/.claude/skills/ai-readiness/` | 对于基于提示的代理， **`AGENTS.md` 是默认和推荐的目标** — 现代代理现在都读取它。 工具特定文件如果您更喜欢它们仍然可用： | 可选目标 | 安装到 | |---|---| | `cursor` | `./.cursor/rules/ai-readiness.mdc` | | `windsurf` | `./.windsurf/rules/ai-readiness.md` | | `copilot` | `./.github/copilot-instructions.md` （分隔块） | | `gemini` | `./GEMINI.md` （分隔块） | | `generic` | `./ai-readiness.SKILL.md` （粘贴到任意系统） | 非-Claude 目标安装到当前目录，因此请从项目根目录运行命令。 `--all` 安装 Claude + `AGENTS.md`。添加 `--force` 以覆盖，或 `--dir <path>` 以更改目标。 共享文件安装插入标记块，并在重新运行时更新它，因此它们永远不会覆盖其他指令。 ### 其他安装选项 - **Claude Cowork 一键安装：** 下载并打开 [`ai-readiness.skill`](ai-readiness.skill)。 - **任意 AI，手动：** 将 [`SKILL.md`](SKILL.md) 复制到助手的系统提示或自定义指令中。 安装后，在 Claude 中使用 `/ai-readiness yoursite.com` 触发它，或询问任意代理： *"为 yoursite.com 创建 AI 准备文件。"* ### 通过 MCP 使用（无需安装） 将您的编码代理连接到托管的 MCP 服务器，而不是在本地安装技能。相同的流程 — 研究网站并生成所有文件。 **生产环境：** `https://ai.silverbackmarketing.com/api/mcp` 连接后示例提示： ``` 生成 example.com 的 AI 准备文件 使用 ai-readiness 列出所有输出文件 获取 ai-readiness 的 llms.txt 文件规格 ``` **Cursor** — 添加到 `.cursor/mcp.json`： ```json { "mcpServers": { "ai-readiness": { "url": "https://ai.silverbackmarketing.com/api/mcp" } } } ``` 刷新 MCP 服务器，然后询问： *"使用 ai-readiness 生成 example.com 的文件"* **Claude Code** — 将 `.mcp.json` 添加到您的项目根目录： ```json { "mcpServers": { "ai-readiness": { "type": "http", "url": "https://ai.silverbackmarketing.com/api/mcp" } } } ``` 或运行： ```bash claude mcp add --transport http ai-readiness https://ai.silverbackmarketing.com/api/mcp ``` 重启会话，运行 `/mcp`，然后询问： *"使用 ai-readiness 生成 mysite.com 的文件"* **VS Code / Copilot** — 添加到 `.vscode/mcp.json`： ```json { "servers": { "ai-readiness": { "type": "http", "url": "https://ai.silverbackmarketing.com/api/mcp" } } } ``` 打开 **MCP：列出服务器**，确认 `ai-readiness` 正在运行，然后在 Copilot Chat 中使用代理模式。 **Claude Desktop** — 在 `~/Library/Application Support/Claude/claude_desktop_config.json` （macOS）中使用 [mcp-remote](https://www.npmjs.com/package/mcp-remote): ```json { "mcpServers": { "ai-readiness": { "command": "npx", "args": ["-y", "mcp-remote", "https://ai.silverbackmarketing.com/api/mcp"] } } } ``` 完全退出并重新打开 Claude Desktop。 **OpenAI Codex** — 添加到 `~/.codex/config.toml`: ```toml [mcp_servers.ai-readiness] url = "https://ai.silverbackmarketing.com/api/mcp" enabled = true ``` 或运行 `codex mcp add ai-readiness --url https://ai.silverbackmarketing.com/api/mcp`，然后在会话中使用 `/mcp`。 **Antigravity** — 代理面板 → … → MCP 服务器 → 管理 → 查看原始配置： ```json { "mcpServers": { "ai-readiness": { "serverUrl": "https://ai.silverbackmarketing.com/api/mcp" } } } ``` Antigravity 使用 `serverUrl`（不是 `url`）。 保存，刷新，然后在代理模式下尝试。 **快速测试：** ```bash curl -X POST 'https://ai.silverbackmarketing.com/api/mcp' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json, text/event-stream' \ -d '{"jsonrpc":"2.0","method":"tools/list","params":{},"id":1}' ``` 更多客户端配置： [ai.silverbackmarketing.com/#mcp](https://ai.silverbackmarketing.com/#mcp) --- ## 它做什么 运行 `/ai-readiness yoursite.com`，AI 将研究网站，分类其行业，并生成生产就绪文件，准确地告诉 AI 系统（ChatGPT、Claude、Gemini、Perplexity 等）网站是什么，提供什么以及在哪里发送用户。 当部署到网站根目录时，这些文件会改善网站在 AI 生成的答案、摘要和推荐中的显示效果 — 任何希望在 AI 驱动的网络中显示的业务都必须具备。 --- ## 文件 该技能生成 **18 个文件**。其中 **17 个部署到您的网站根目录**，跨 7 个类别（**16 个，如果省略可选的 `.well-known/ai-plugin.json`**）；第 18 个，`README.md`，是您团队的项目文档。 这与 [现场站点上描述的 17 文件套件](https://ai.silverbackmarketing.com/#files) 匹配。 | # | 文件 | 目的 | 部署 | |---|------|---------|:---:| | 1 | `ai.txt` | 主要 AI 身份声明 | ✅ | | 2 | `llms.txt` | 简洁的 LLM 可读站点摘要 | ✅ | | 3 | `llms-full.txt` | 全面的 LLM 知识库 | ✅ | | 4 | `ai-sitemap.xml` | AI 优化的站点地图 | ✅ | | 5 | `sitemap.md` | AI 上下文的人类可读站点地图 | ✅ | | 6 | `ai-entities.json` | 结构化实体定义 | ✅ | | 7 | `ai-intent.json` | 用户意图和查询映射 | ✅ | | 8 | `ai-schema.json` | Schema.org 结构化数据 | ✅ | | 9 | `rag-index.json` | RAG 检索知识库 | ✅ | | 10 | `rag-index.jsonl` | JSONL 格式用于嵌入管道 | ✅ | | 11 | `ai-disclosure.txt` | AI 内容透明度声明 | ✅ | | 12 | `training-data-policy.txt` | 数据使用和训练政策 | ✅ | | 13 | `.well-known/ai-plugin.json` | AI 代理的插件清单（可选） | ➖ | | 14 | `structured-data-guide.md` | 开发者实施指南 | ✅ | | 15 | `manifest.json` | Web 应用清单 | ✅ | | 16 | `deployment-checklist.md` | 分步部署指南 | ✅ | | 17 | `robots.txt` | AI 爬虫指令 | ✅ | | 18 | `README.md` | 项目文档（不部署） | ➖ | --- ## 用法 在 Claude Cowork 中输入： ``` /ai-readiness yoursite.com ``` 或使用自然语言： ``` 为 acmecorp.com 创建 AI 准备文件 使我的站点 AI 就绪：hubspot.com 为 shopify.com 生成 llms.txt ``` Claude 将： 1. 运行 10+ 个有针对性的搜索来研究站点 2. 分类站点类型（SaaS、电子商务、教育、医疗保健等） 3. 为该行业生成所有文件 4. 将所有文件保存到您工作区中以域名命名的文件夹中 --- ## 常见问题 **什么是 AI 准备文件？** 它们是在网站根目录部署的结构化文件，用于准确地告诉 AI 系统您是谁、您提供什么以及在哪里发送用户。它们采用 AI 已经理解的格式，因此助手不再根据过时的训练数据猜测您的品牌，而是在他们的答案中准确地代表您。 **为什么现在 AI 准备很重要？** 当有人想要产品推荐、服务提供商或直接答案时，他们通常会在访问网站之前询问 ChatGPT、Claude、Gemini 或 Perplexity。 如果您没有向这些系统提供清晰、当前的信息，他们会猜测。 而且他们经常猜错。 **工具包中有多少个文件？** 该工具包包括 17 个针对不同目的的文件，跨 7 个类别：身份和权限、内容文件、地图和导航、智能文件、研究文件、政策文件和操作文件。 每个文件都有助于 AI 更准确地理解和表示您的站点。 （该技能总共生成 18 个文件 — 额外的文件是此 `README.md` 用于您的项目。） **我应该从哪里开始？** 从关键文件开始：`robots.txt`、`ai.txt`、`llms.txt` 和 `llms-full.txt`。 它们会带来立即的影响，是大多数 AI 系统首先查找的内容。 然后使用部署清单添加站点地图、智能 JSON 文件、政策和操作文件。 **robots.txt 对 AI 有什么作用？** robots.txt 位于网站的入口，告诉自动化访问者（搜索引擎、AI 机器人和爬虫）哪些部分可以访问。 对于 AI 准备，它包括针对主要爬虫（如 GPTBot 和 ClaudeBot）的指令，指向您的 `llms.txt` 和 `ai-sitemap.xml`，同时阻止结账、登录和管理页面访问。 **什么是 ai.txt？** ai.txt 是您品牌对互联网上所有 AI 系统的介绍。 robots.txt 控制访问，而 ai.txt 更进一步。 它涵盖了您销售的产品、您而知名的事物、您的权威话题以及 AI 系统可以和不能对您的内容执行的操作。 **ai.txt 和 robots.txt 有什么区别？** robots.txt 控制访问：哪些页面机器人可以爬取。 ai.txt 控制身份：您是谁、您提供什么以及您的 AI 使用内容的基本规则。 把 robots.txt 看作门童，把 ai.txt 看作您在采访前交给记者的简介文件。 **什么是 llms.txt？** llms.txt 是为大型语言模型构建的结构化文本文件。 它为 AI 提供网站的快速地图：公司名称、描述、有组织的章节和直接链接以及站点最常见的问题。 它遵循 [llmstxt.org](https://llmstxt.org) 由 ChatGPT、Claude、Gemini 和 Perplexity 使用的标准。 **llms.txt 和 llms-full.txt 有什么区别？** llms.txt 是速查表：AI 可以在几秒钟内扫描的快速摘要。 llms-full.txt 是深入研究：包含详细描述、详细问答和完整的类别解释。 如果 llms.txt 是维基百科摘要，llms-full.txt 是完整文章。 **为什么我需要 ai-sitemap.xml？** 常规站点地图列出页面和时间戳。 AI 站点地图添加每个页面内容类型和纯英文摘要。 这是纸质地图和具有兴趣点的 GPS 之间的区别。 AI 爬虫可以理解页面而不需要获取和解析每个页面。 **什么是 ai-intent.json？** ai-intent.json 将真实的用户问题（人们在 AI 助手中的输入）映射到您网站上回答每个问题的最佳页面。 没有它，AI 会猜测页面推荐。 有了它，您给 AI 一个直接的 URL 用于每个常见查询。 **什么是 ai-entities.json 和 ai-schema.json？** ai-entities.json 是您站点的结构化目录：产品、类别、服务和关键概念。 它支持 AI 知识图谱。 ai-schema.json 使用 Schema.org 标准以机器可读的格式描述您的组织，以便搜索引擎和 AI 系统可以准确识别您。 **什么是 RAG 索引文件？** rag-index.json 和 rag-index.jsonl 和 ai-index.json 是为 AI 研究和检索管道准备的现成索引。 当用户提出问题时，AI 首先会从此索引中提取最相关的文档，然后生成答案，从而使响应基于您的实际内容。 **什么是训练数据政策？** training-data-policy.txt 制定了 AI 公司如何使用您的内容的正式规则，包括模型训练、RAG 索引和商业使用。 它回答了每个品牌应该预先确定的一个实际问题：允许他人对您的作品执行什么操作。 **什么是 ai-disclosure.txt？** ai-disclosure.txt 是一份公共透明度报告，解释了您的组织如何使用 AI，无论是用于内容生成、推荐还是客户交互。 它通过在有人询问之前回答这些问题来建立信任。 **我应该多久更新一次 AI 准备文件？** 这取决于文件。 每月更新 `llms.txt` 和站点地图，当站点结构发生变化时更新。 每季度刷新 `ai.txt` 和 `llms-full.txt`，当产品发生变化时更新。 每年审查政策文件。 `manifest.json` 文件列出了建议的更新频率。 --- ## 参考文档 [`references/file-specs.md`](references/file-specs.md) 文件包含每个文件的详细规范 — 结构、关键字段和压缩示例。 它在技能运行时自动加载。 [`scripts/gen_jsonl.py`](scripts/gen_jsonl.py) 实用程序将 `rag-index.json` 转换为 `rag-index.jsonl` 格式，供嵌入管道使用： ```bash python3 scripts/gen_jsonl.py rag-index.json rag-index.jsonl ``` --- ## PDF 指南 [`docs/`](docs/) 文件夹包含 PDF 参考指南，用通俗易懂和技术细节解释每个文件： | 指南 | 受众 | 涵盖文件 | |-------|----------|---------------| | [AI 准备指南 — 含插件](docs/ai-readiness-guide-with-plugin.pdf) | 通用 / 非技术 | 17 个文件均包含 ai-plugin.json | | [AI 准备指南 — 无插件](docs/ai-readiness-guide-no-plugin.pdf) | 通用 / 非技术 | 16 个文件，不含 ai-plugin.json | | [开发者参考 — 含插件](docs/ai-readiness-guide-dev-with-plugin.pdf) | Web 开发者 | 17 个文件，紧凑的技术格式 | | [开发者参考 — 无插件](docs/ai-readiness-guide-dev-no-plugin.pdf) | Web 开发者 | 16 个文件，紧凑的技术格式 | --- ## 技能文件结构 ``` ai-readiness/ ├── ai-readiness.skill ← Claude Cowork 可安装技能（下载并打开） ├── SKILL.md ← 原始技能定义 — 在任何 AI 助手中使用 ├── README.md ← 此文件 ├── references/ │ └── file-specs.md ← 输出文件的详细规范 ├── scripts/ │ └── gen_jsonl.py ← JSONL 生成器实用程序 └── docs/ ├── ai-readiness-guide-with-plugin.pdf ├── ai-readiness-guide-no-plugin.pdf ├── ai-readiness-guide-dev-with-plugin.pdf └── ai-readiness-guide-dev-no-plugin.pdf ``` --- ## 作者和公司 **Russ Wittmann** — Silverback 营销高级副总裁 [LinkedIn](https://www.linkedin.com/in/russwittmann/) · [X / Twitter](https://x.com/russwittmann) [Silverback 营销](https://silverbackmarketing.com) 是一家 ROI 驱动的数字营销机构（2007 年成立，总部位于亚利桑那州皇后镇），帮助企业通过策略、内容和技术增长。 该技能是 Silverback AI 准备服务产品的一部分 — 帮助客户在 AI 搜索时代获得关注。 🔗 **[ai.silverbackmarketing.com](https://ai.silverbackmarketing.com)** · [silverbackmarketing.com](https://silverbackmarketing.com) --- ## 许可证 MIT — 免费使用、修改和分发，需注明出处。 见 [`LICENSE`](LICENSE)。