8.0
热点
AI SCORE
编程提效2026-08-30 20:33
让AI编程助手实时读取运行中服务的API文档
dev.to · AI#AI编程助手#OpenAPI#工具
Editor brief · 编辑速览
docs-mcpserver从运行中服务提取OpenAPI规范并缓存,AI按需获取单个路由定义而非全量加载,解决AI编码助手使用过期swagger文档的痛点。
一个编写前端代码的 Agent 必须了解后端的 API。它有三种选择:阅读后端源码,从零推导服务已经发布的接口;向用户提问,但这会把用户变成 API 文档;或者吞下整个 OpenAPI 文档,只为使用其中一条路由。
然后明天再来一遍,面对上周导出的一张过时的 swagger.json。
docs-mcpserver 从运行中的服务直接获取规范,进行缓存,并按需一次提供一个操作。
{
"cacheDir": "./cache",
"libraries": [
{
"name": "orders-api",
"description": "Order handling service",
"sources": [
{
"type": "url",
"origin": "https://localhost:5001/openapi/v1.json",
"kind": "schema",
"name": "orders"
}
]
}
]
}
npm install -g docs-mcpserver
claude mcp add docs -- docs-mcpserver --config /path/to/dev-docs.json
这就是全部配置。
一次一个操作,不是整个规范
Agent 按顺序列出定义,选择所需的那个,然后只获取它。对于 OpenAPI 文档,路径操作被暴露为名为 GET /orders/{id} 的定义,因此也可以按关键词搜索。
只需要几百个 token 来获取它正在对接的那个操作,而不是整个文档。随着服务不断增长,这种方式依然有效,而粘贴过来的规范很快就会过时。
后端不必一直运行
每次调用都从缓存的规范中应答,从不访问网络。抓取在启动时发生,之后在后台持续进行,所以你 20 秒前添加的端点已经可见。
启动一次后端,关闭它,继续构建前端。Agent 仍然拥有真实的路由和真实的 payload 结构。如果服务宕机了,或者返回的不是规范,上一次已知正常的副本会继续提供服务。
代码与问题反馈:github.com/jgauffin/dev-docs-mcp。npm 上包名为 docs-mcpserver。