🚀 项目标题 - MCP OpenAPI文档管理及检索工具集合
这是一套专门用于管理和检索OpenAPI文档的MCP工具集合，能有效帮助用户便捷地管理和查找API信息，支持远程和本地文档，且每次请求自动刷新，确保信息实时性。
🚀 快速开始
你可以通过命令行快速使用本工具集合，使用以下命令：
npx api-doc-mcp
示例用法
- 查看帮助信息：
npx api-doc-mcp
- 列出所有远程API分组：
npx api-doc-mcp https://api.example.com/swagger.json
- 列出本地文件中的所有API分组：
npx api-doc-mcp ./swagger.json
✨ 主要特性
此工具包提供了以下实用功能：
- 列出所有API分组
- 在指定分组中列出所有API
- 获取特定API的详细信息
- 搜索API
- 支持远程API文档和本地JSON文件
- 每次请求时自动刷新API文档
💻 使用示例
基础用法
通过命令行调用工具，例如列出远程API分组：
npx api-doc-mcp https://api.example.com/swagger.json
高级用法
在开发阶段，你可以使用以下命令进行开发：
npm run dev
📚 详细文档
listApiGroups
列出所有可用的API分组。
返回值：
| 属性 | 详情 |
|---|---|
| name | 分组名称 |
| description | 分组描述 |
| apiCount | API数量 |
listGroupApis
在指定分组中列出所有API。
参数：
| 属性 | 详情 |
|---|---|
| groupName | API分组名称 |
返回值：
| 属性 | 详情 |
|---|---|
| path | API路径 |
| method | HTTP方法 |
| summary | API摘要 |
getApiDetail
获取特定API的详细信息。
参数：
| 属性 | 详情 |
|---|---|
| path | API路径 |
| method | HTTP方法 |
返回值：
完整的API详情，包括参数、请求体和响应定义
searchApis
搜索API。
参数：
| 属性 | 详情 |
|---|---|
| keyword | 搜索关键字 |
返回值：
| 属性 | 详情 |
|---|---|
| path | API路径 |
| method | HTTP方法 |
| summary | API摘要 |