面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/read-docs-with-ai-agents.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

选择读取方式

AI Agent 读取文档时,应优先使用能够结构化检索并按需返回内容的入口。目标页面已知时,直接读取 Markdown 镜像;其他方式不可用时,再读取 HTML 页面。

优先级 方式 适用场景 说明
1 文档 MCP Agent 支持 MCP,需要检索文档、API、代码示例或模型信息 文档 MCP 提供结构化工具和按需读取能力,减少 Agent 自行维护 URL 和解析页面的成本。
2 llms.txt 系列文件 Agent 可以访问公网,但未接入 MCP;需要发现页面或获取批量语料 llms.txt 用于发现文档;llms-full.txt 和章节全文文件用于构建知识库或离线检索。
3 Markdown 镜像 已知目标页面地址,只需要页面正文 在文档页面 URL 后追加 .md,获取 text/markdown 内容,避免 HTML 页面中的导航和样式代码。
4 HTML 页面 Agent 只能使用网页读取工具,或目标页面没有可用的 Markdown 镜像 网页解析工具通常能够提取正文,但原始 HTML 同时包含导航、脚本、样式和页面元数据,会增加无关上下文。

配置 Agent 读取规则#

将以下规则加入 Agent 的系统提示词。规则包含文档 MCP、llms.txt 和页面 URL 的完整入口:

text
回答产品相关问题前,按以下顺序读取最新官方文档:
1. 如果客户端支持 MCP,连接 https://mcp.ark-doc-resources.cn/mcp/,
   使用文档 MCP 检索并读取目标内容。
2. MCP 不可用时,读取 https://ark.volcengine.com/llms.txt,
   根据标题和简介定位相关页面,再读取命中文档的 Markdown 链接。
3. 构建知识库或执行离线检索时,读取 https://ark.volcengine.com/llms-full.txt,
   或读取 llms.txt 中对应章节的“章节全文”链接。不要把全站全文直接注入单次对话。
4. 已知文档页面 URL 时,读取 <DOC_URL>.md,优先使用 Markdown 镜像。
5. <DOC_URL>.md 不可用时,读取 <DOC_URL>,并且只保留文章标题、正文、
   代码块、表格和链接;忽略导航、脚本、样式、页脚和交互控件。
6. 回答时引用读取到的最新官方文档,不要只依赖已有知识。
  1. Agent 已接入文档 MCP 时,使用 MCP 检索并读取目标内容。
  2. MCP 不可用时,读取 llms.txt,根据标题和简介定位相关页面。
  3. 构建知识库或执行离线检索时,读取 llms-full.txt 或章节全文文件。
  4. 已知目标页面时,读取 <DOC_URL>.md。
  5. <DOC_URL>.md 不可用时,读取 HTML 页面,并且只保留正文内容。
  • 配置结构化检索工具,详情请参见文档 MCP。
  • 使用索引、章节全文或全站全文读取文档,详情请参见llms.txt。
  • 直接读取 Markdown 镜像或 HTML 页面,详情请参见通过 URL。
  • 安装文档配套能力,详情请参见文档 Skill。