在 AI 工具中使用本文档
本文档的每一页都有给 AI 读的 Markdown 版本,另有整站目录、全文合集、OpenAPI 规格和一个 MCP 服务。让 DeepSeek、ChatGPT、Claude、Cursor、Claude Code 等工具按 LYRouter 的接口写代码时,把下面任一份交给它,比让它凭记忆猜更准确。
下文的地址都在控制台域名 https://platform.lyrouter.com 上,不是网关地址 https://api.lyrouter.com。
选择哪一种
| 用途 | 交给 AI 的内容 |
|---|---|
| 就某一页提问 | 页面顶部的「复制为 AI 阅读友好的格式」 |
| 让 AI 自己找相关的页 | llms.txt |
| 一次把全部文档交给 AI | llms-full.txt |
| 生成客户端代码、校验请求 | OpenAPI 规格 |
| 在编辑器或命令行里随时查文档 | MCP 服务 |
页面上的按钮
每页标题下方有 复制为 AI 阅读友好的格式 按钮:复制本页的 Markdown,粘贴到任意 AI 对话中即可提问。复制内容开头写有本页地址;站内链接已改成完整地址,截图换成文字说明,代码块原样保留。
每页的 Markdown 地址
在页面地址后加 .md,就是这一页的 Markdown 版本,内容与「复制为 AI 阅读友好的格式」相同:
| 页面 | Markdown 地址 |
|---|---|
https://platform.lyrouter.com/ai_gateway/docs/errors |
https://platform.lyrouter.com/ai_gateway/docs/errors.md |
https://platform.lyrouter.com/ai_gateway/docs/errors/en |
https://platform.lyrouter.com/ai_gateway/docs/errors/en.md |
英文版的地址带 /en;只有中文的文章没有 en.md。
llms.txt 与 llms-full.txt
按 llms.txt 约定 提供两个文件:
| 文件 | 内容 |
|---|---|
/llms.txt |
文档目录:每页的标题、Markdown 地址和一句摘要,中文在前、英文在后,末尾列出 OpenAPI 规格和 MCP 服务的地址 |
/llms-full.txt |
全部中文文章的 Markdown 合集,每篇以 --- 分隔、开头写有原文地址 |
llms-full.txt 较长,适合上下文窗口大的模型,或作为知识库文件上传。只需要部分内容时,先给 llms.txt,让 AI 按目录抓取所需的页。
OpenAPI 规格
| 文件 | 范围 |
|---|---|
| lyrouter-openapi.yaml | 对话(Chat Completions、Responses、Anthropic Messages)、向量、重排、列出模型 |
| multimodal-openapi.yaml | 图像生成与编辑、视频任务等多模态接口 |
两份都是 OpenAPI 3.1,可以直接交给 AI 作为接口依据,也可以用代码生成器得到客户端:
npx openapi-typescript https://platform.lyrouter.com/ai_gateway/api-spec/lyrouter-openapi.yaml \
-o ./src/lyrouter-api.d.ts
规格描述的是网关对外的接口;某个模型实际接受哪些参数,以各接口页和协议兼容性与限制为准。
MCP 服务
文档提供一个 MCP 服务,地址为:
https://platform.lyrouter.com/api/v1/docs/mcp
传输方式为 Streamable HTTP,不需要 API Key。服务提供两个工具:
| 工具 | 作用 |
|---|---|
search_docs |
按关键词或问题搜索文档(中英文均可),返回匹配页的标题、页面地址、Markdown 地址和摘要 |
get_doc |
按页面标识(如 errors)或页面地址读取一页的完整 Markdown,可选中文或英文 |
在 Claude Code 中添加:
claude mcp add --transport http lyrouter-docs https://platform.lyrouter.com/api/v1/docs/mcp
在 Cursor 中,把下面的配置写入 ~/.cursor/mcp.json(只对当前项目生效时写入项目的 .cursor/mcp.json):
{
"mcpServers": {
"lyrouter-docs": {
"url": "https://platform.lyrouter.com/api/v1/docs/mcp"
}
}
}
其他支持远程 MCP 的工具,按其说明添加同一地址即可。添加后,向 AI 提问时说明「查 LYRouter 文档」,它会调用上面的工具取得最新内容。
常见问题
AI 说打不开文档地址,怎么办?
答: 部分 AI 产品在对话中不能联网,或不能访问任意地址。改用「复制为 AI 阅读友好的格式」,把内容直接粘贴进对话。
AI 给出的参数和本文档不一致,以哪个为准?
答: 以本文档为准。AI 可能混用了 OpenAI、Anthropic 官方文档或旧版本的内容,可以把相关页的 Markdown 交给它重新回答。