项目概述

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

功能特点

此工具包提供了以下功能：

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

使用方法

通过命令行使用（Command Format）

npx api-doc-mcp <API_DOC_URL_OR_FILE_PATH>

示例用法

1. 查看帮助信息：

   npx api-doc-mcp
   

2. 列出所有远程API分组：

   npx 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摘要