
api-doc-mcp

2025.03.10
2
TypeScriptAPI 文档管理OpenAPI 工具开发效率
api-doc-mcp 是一套用于管理和检索 OpenAPI 文档的 MCP 工具集。它提供了列出 API 组、列出指定组中的 API、获取 API 详细信息、搜索 API 等功能,支持远程 API 文档和本地 JSON 文件,并能在每次请求时自动刷新 API 文档。
View on GitHub
Overview
基本能力
产品定位
api-doc-mcp 是一个用于管理和检索 OpenAPI 文档的工具集,旨在帮助开发者更高效地浏览和查询 API 文档。
核心功能
- 列出所有 API 组:显示所有可用的 API 组及其描述和 API 数量。
- 列出指定组中的 API:根据组名列出该组中的所有 API,包括路径、HTTP 方法和摘要。
- 获取 API 详细信息:提供指定 API 的完整详细信息,包括参数、请求体和响应定义。
- 搜索 API:通过关键词搜索 API,返回匹配的 API 路径、方法和摘要。
- 支持远程和本地文档:可以处理远程 API 文档(如 Swagger JSON)或本地 JSON 文件。
- 自动刷新文档:每次请求时自动刷新 API 文档,确保数据最新。
适用场景
- 开发调试:快速查找和浏览 API 文档,提高开发效率。
- 文档管理:集中管理和检索多个 API 组的文档。
- 团队协作:方便团队成员共享和查询 API 文档。
工具列表
- listApiGroups:列出所有 API 组,返回组名、描述和 API 数量。
- listGroupApis:列出指定组中的所有 API,返回路径、HTTP 方法和摘要。
- getApiDetail:获取指定 API 的详细信息,包括参数、请求体和响应定义。
- searchApis:通过关键词搜索 API,返回匹配的 API 路径、方法和摘要。
常见问题解答
- 如何查看帮助?
bash npx api-doc-mcp
- 如何列出所有 API 组?
bash npx api-doc-mcp https://api.example.com/swagger.json
- 如何使用本地文件?
bash npx api-doc-mcp ./swagger.json
使用教程
使用依赖
- 确保已安装 Node.js 和 npm。
安装教程
- 通过 npx 直接运行工具:
bash npx -y api-doc-mcp http://localhost:8000/swagger.json
或使用本地文件:bash npx -y api-doc-mcp ./swagger.json
调试方式
- 开发模式下运行:
bash npm run dev
- 构建项目:
bash npm run build
许可证
None