Swagger MCP Server
2025.04.23
0
TypeScriptAPI 文档解析API 查询工具开发效率
Swagger MCP Server 是一个基于 Model Context Protocol (MCP) 的服务，专门用于解析 Swagger/OpenAPI 规格文件，并提供工具来查询和分析 API 端点。它支持 Swagger 2.0 和 OpenAPI 3.0 格式，能够从本地文件或 URL 获取文档，并提供 API 端点列表查询、详细信息查询等功能。此外，它还支持与 Claude 或其他 AI 助手的集成。
View on GitHub
Overview
基本能力
产品定位
Swagger MCP Server 是一个用于解析和查询 Swagger/OpenAPI 文档的工具，旨在帮助开发者更高效地分析和使用 API。
核心功能
- 支持通过文件路径或 URL 获取 Swagger/OpenAPI 文档
- 支持 Swagger 2.0 和 OpenAPI 3.0 格式
- 提供 API 端点列表查询，支持指定深度和过滤条件
- 提供 API 端点详细信息查询
- 提供符合 MCP 规范的工具接口，支持与 Claude 或其他 AI 助手的集成
适用场景
- API 文档的分析和查询
- 开发者工具集成
- AI 助手对 API 文档的自动化处理
工具列表
- listEndpoints：获取 API 端点列表，支持指定深度和过滤条件。
- 参数：
depth（查询深度级别）、filter（前缀过滤条件） - getEndpointDetail：获取特定 API 端点的详细信息。
- 参数：
path（API 端点的完整路径）、method（HTTP 方法） - swagger-info：获取 Swagger 文档的信息。
- URI 格式：
swagger-info://{type} - 类型：
general（一般信息）、paths（路径信息）、schemas（数据模型信息）
常见问题解答
- 无
使用教程
使用依赖
# 使用bun安装依赖
bun install
安装教程
# 从本地文件启动
bun run src/index.ts --file examples/petstore.json
# 从 URL 启动
bun run src/index.ts --url https://petstore.swagger.io/v2/swagger.json
调试方式
# 构建
bun run build
# 运行测试
bun test