Swagger Explorer MCP

基本能力

产品定位

Swagger Explorer MCP 是一个专门用于探索和分析 Swagger/OpenAPI 规范的工具，旨在帮助开发者更高效地理解和集成 API 文档。

核心功能

1. 认证支持
2. 支持 Bearer token 认证

3. 可通过环境变量配置

4. 自定义响应格式

5. 最小化格式：移除 null/空值
6. 详细格式：包含元数据和时间戳

7. 原始格式：未修改的响应

8. 模式分析

9. 详细属性探索
10. 响应模式分析

11. 模式关系

12. API 探索

13. 路径列表
14. 方法过滤
15. 响应格式分析

适用场景

1. API 文档审查
2. 模式验证
3. 响应分析
4. 集成规划

工具列表

1. npx -y @johnneerdael/swagger-mcp：全局安装并运行 MCP 服务器
2. curl：用于与 MCP 服务器交互，探索 API、获取模式详情和响应模式

常见问题解答

1. 连接问题
2. 确保 Swagger URL 可访问
3. 检查认证令牌是否正确

4. 验证端口是否未被占用

5. 授权错误

6. 验证 AUTH_TOKEN 是否正确设置

7. 确保请求中包含 bearer token

8. 模式未找到

9. 检查模式名称是否完全匹配
10. 验证 Swagger 规范是否正确加载

使用教程

使用依赖

1. 确保已安装 Node.js 和 npm

安装教程

1. 使用 npx 全局安装并运行： bash npx -y @johnneerdael/swagger-mcp

或使用环境变量安装： bash npx -y @johnneerdael/swagger-mcp \ --env BASE_URL=/api \ --env AUTH_TOKEN=your-token \ --env PORT=3000

1. 对于 Claude Desktop 安装：
2. 打开 Claude Desktop
3. 点击设置（齿轮图标）
4. 选择“工具与集成”
5. 点击“添加 MCP 服务器”
6. 输入以下信息： 名称: Swagger Explorer 命令: npx -y @johnneerdael/swagger-mcp 参数: --swagger-url=$SWAGGER_URL
7. 点击“安装”

调试方式

1. 运行以下命令检查服务器是否正常运行： bash curl -X POST http://localhost:3000/api/explore \ -H "Authorization: Bearer your-token" \ -H "Content-Type: application/json" \ -d '{ "url": "http://your-swagger-url", "options": { "paths": true, "schemas": true } }'

2. 检查日志以获取调试信息。

许可证

该项目遵循 MIT 开源许可条款。