让其他 AI 快速访问平台文档
VitePress 负责面向人的页面;Skill、llms.txt 和 OpenAPI 才是面向编码智能体的入口。根据 AI 能力选择最小但足够的上下文。
推荐顺序
| AI 能力 | 推荐入口 |
|---|---|
| 支持安装 Skill | 下载开发 Skill |
| 能读取网页 URL | llms.txt |
| 需要一次性完整上下文 | llms-full.txt |
| 需要精确生成接口代码 | openapi.json |
| 只能读取单页 | 从 快速开始 开始 |
给编码 AI 的提示词
text
请先阅读 https://<platform-host>/developers/llms.txt,
再为当前项目接入小雅开放平台 OAuth 2.0、可用模型目录和模型网关。
Personal 与 Team Token 必须隔离保存;不要把任何 Token 或 Client Secret 写进前端。llms.txt
llms.txt 是文档入口索引,列出每个页面的目的、完整上下文、公开 OpenAPI 和 Skill 下载地址。它是一种便于 AI 使用的行业约定,不是授权协议,也不能替代 OAuth Scope 和服务端校验。
llms-full.txt
构建脚本从中英文 Markdown 自动合并完整上下文,避免人工维护第二套 AI 文档。文档较大时优先让 AI 读取 llms.txt 后按需访问单页,减少无关上下文。
公开 OpenAPI
openapi.json 只描述开放给第三方的 OAuth、模型目录和模型网关关键接口,不直接暴露运营后台完整 FastAPI Schema。它用于精确字段和代码生成;安全语义、Token 保存和 Team 限制仍以对应指南为准。
是否需要文档 MCP?
第一阶段不需要。文档是静态的,Skill 与 llms.txt 已覆盖常见编码 Agent。只有当文档规模明显增长、需要动态检索或必须按租户返回实时能力时,再增加只读文档 MCP;不要为静态 Markdown增加长期运行服务。
