api-doc-mcp

这是一套用于管理和检索OpenAPI文档的MCP工具集。

功能

此工具包提供以下功能：

1. 列出所有API组
2. 列出指定组中的API
3. 获取API详情
4. 搜索API
5. 支持远程API文档和本地JSON文件
6. 在每次请求时自动刷新API文档

使用方法

对于光标

# 远程API
npx -y api-doc-mcp http://localhost:8000/swagger.json

# 本地文件
npx -y api-doc-mcp ./swagger.json

构建

npm run build

使用方法

命令格式

npx api-doc-mcp <API_DOC_URL_OR_FILE_PATH>

示例

1. 查看帮助：

npx api-doc-mcp

2. 列出所有API组（远程API）：

n
px api-doc-mcp https://api.example.com/swagger.json

3. 列出所有API组（本地文件）：

npx api-doc-mcp ./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概述