核心概念
AI 可读产物
了解 AI 可读产物的结构和使用场景。
Anydocs 在构建阶段同时生成面向读者搜索和面向机器读取的结果。理解这些产物的分工,才能知道用户该看什么、AI 该读什么。
先区分搜索和 AI 产物
并不是所有 JSON 都适合作为 AI 主输入。
- `search-index.<lang>.json`:服务 reader 内搜索,目标是帮助读者查找页面与章节
- `llms.txt`:轻量目录式 AI 入口,适合先发现站点结构
- `llms-full.txt`:全站顺序文本导出,适合粗粒度 fallback
- `mcp/*.json`:结构化机器可读产物,适合 agent 按需读取
文本型 AI 入口
当外部 agent 只需要快速发现或粗读整站内容时,优先看文本型产物。
- `llms.txt`:更轻,适合先发现站点和页面入口
- `llms-full.txt`:更重,适合一次性获取全站顺序文本
- 这两类文件都是构建产物,只包含 `published` 内容
结构化机器可读产物
当 agent 需要按页面、导航或内容块精准读取时,优先看 `mcp/`。
- `mcp/index.json`:产物索引
- `mcp/pages.<lang>.json`:页面级摘要和公开 metadata
- `mcp/chunks.<lang>.json`:按块切分的内容,最适合按需读取
- `mcp/navigation.<lang>.json`:发布后的导航数据
- `mcp/openapi/index.<lang>.json`:API sources 的机器可读索引(配置后生成)
公开边界和可见性
AI 产物并不会暴露源项目中的全部信息。
- 只有 `published` 页面会进入 `llms.txt`、`llms-full.txt` 和 `mcp/`
- `draft` 与 `in_review` 页面保留在 canonical source 中,但不会进入公开 AI 产物
- `mcp/pages.<lang>.json` 只暴露 visibility 为 `public` 的 metadata 字段
给 agent 的读取顺序: 先用 `llms.txt` 发现结构,再按需切到 `mcp/navigation.<lang>.json`、`mcp/pages.<lang>.json`、`mcp/chunks.<lang>.json`,通常比直接吞整站文本更稳。