api文档mcp
这是一组用于管理和检索OpenAPI文档的MCP工具。
特性
此工具包提供以下功能：
- 列出所有API组
- 列出指定组中的API
- 获取API详细信息
- 搜索API
- 同时支持远程API文档和本地JSON文件
- 根据每个请求自动刷新API文档
用法
用于光标
# remote api
npx -y api-doc-mcp http://localhost:8000/swagger.json
# local file
npx -y api-doc-mcp ./swagger.json构建
npm run build用法
命令格式
npx api-doc-mcp 例子
- 查看帮助：
npx api-doc-mcp- 列出所有API组（远程API）：
npx api-doc-mcp https://api.example.com/swagger.json- 列出所有API组（本地文件）：
npx api-doc-mcp ./swagger.json发展
npm run dev工具说明
listApiGroups
列出所有可用的API组。
退货：
- name:组名
- description:组描述
- apiCount：API计数
listGroupApis
列出指定组中的所有API。
参数：
- groupName:API组名称
退货：
- 路径：API路径
- 方法：HTTP方法
- 摘要：API摘要
getApiDetail
获取有关指定API的详细信息。
参数：
- 路径：API路径
- 方法：HTTP方法
退货：
- 完整的API详细信息，包括参数、请求主体和响应定义
searchApis
搜索API。
参数：
- 关键字：搜索关键字
退货：
- 路径：API路径
- 方法：HTTP方法
- 摘要：API摘要