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

llms.txt

llms.txt 系列文件适合未接入文档 MCP、但能够访问公网 URL 的 AI Agent。Agent 先通过索引发现目标文档,再按需读取命中的 Markdown 内容,可以减少无关上下文。

获取文件地址#

文档站提供以下文件:

文件 地址 说明
文档索引 llms.txt 按目录列出公开文档的标题、简介和 Markdown 链接。
文档全文 llms-full.txt 汇总当前发布版本的全部公开文档正文。
章节全文 以 llms.txt 中的“章节全文”链接为准 汇总一个目录章节下的公开文档正文,例如 AI 套件章节全文。

这些文件无需注册或 API Key,由文档系统随发布自动更新。

了解文件内容#

llms.txt 是 Markdown 格式的文档索引:

  • 每个二级标题对应一个目录章节。
  • 每个章节的“章节全文”链接指向该章节的 Markdown 合集。
  • 每篇文档按 - [文档标题](文档地址): 简介 的格式列出,链接直接指向该页面的 Markdown 镜像。

索引内容示例:

Markdown
## AI 套件

- [章节全文](https://ark.volcengine.com/llms-full/ai-suite.txt)
- [ArkCLI 快速入门](https://ark.volcengine.com/region:cn-beijing/docs/ark-cli.md): ArkCLI 快速入门说明……

llms-full.txt 和章节全文文件是纯 Markdown 文本。全站文件内容较多,适合持久化后建立检索索引;单次问答优先读取 llms.txt 和命中的单篇文档。

选择使用方式#

按需读取单篇文档#

该方式适合问答、排障和生成代码等任务:

  1. 读取 llms.txt。
  2. 根据标题和简介定位相关文档。
  3. 读取命中文档的 Markdown 链接。
  4. 基于文档内容回答,并在需要时继续读取关联页面。

读取一个章节#

该方式适合需要同一主题下多篇文档的任务。读取 llms.txt 中对应章节的“章节全文”链接,避免加载无关章节。

建立文档知识库#

该方式适合离线检索或知识库构建。定期获取 llms-full.txt 或章节全文文件,保存版本并建立检索索引。不要把全站全文直接注入单次对话。

配置 Agent 读取规则#

将以下规则加入 Agent 的系统提示词,或在对话中直接发送:

text
当问题涉及当前产品时,先读取 https://ark.volcengine.com/llms.txt,
根据标题和简介定位相关文档,再读取命中文档的 Markdown 链接。
回答时以最新官方文档为准,不要只依赖已有知识。
  • 比较全部读取方式,详情请参见选择读取方式。
  • 直接读取 Markdown 镜像或 HTML 页面,详情请参见通过 URL。
  • 配置结构化检索工具,详情请参见文档 MCP。