AI导哈

OpenAPI文档管理工具

一个用于管理和检索OpenAPI文档的工具集，支持列出API组、搜索API、获取API详情等功能，适用于本地和远程API文档。

  • by zkytech
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 zkytech/api-doc-mcp

使用说明

api文档mcp

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

特性

此工具包提供以下功能：

  1. 列出所有API组
  2. 列出指定组中的API
  3. 获取API详细信息
  4. 搜索API
  5. 同时支持远程API文档和本地JSON文件
  6. 根据每个请求自动刷新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 <API_DOC_URL_OR_FILE_PATH>

例子

  1. 查看帮助：
npx api-doc-mcp
  1. 列出所有API组（远程API）：
npx api-doc-mcp https://api.example.com/swagger.json
  1. 列出所有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摘要

相关 MCP