基本能力
产品定位
Swagger-MCP 是一个用于连接 Swagger 规范并生成 MCP 服务器的工具,旨在帮助 AI 快速构建和集成 API 服务。
核心功能
- 下载并本地存储 Swagger 规范
- 返回所有端点及其 HTTP 方法和描述
- 返回所有模型列表
- 返回单个模型详情
- 提供连接到端点的服务
- 返回 MCP 函数定义
- 生成完整的 MCP 工具定义(包含完整的模式信息)
- 在工具描述中包含 AI 特定指令
适用场景
- 快速生成 API 服务的 MCP 服务器
- 为 AI 助手提供 API 集成支持
- 自动化生成 TypeScript 代码和 MCP 工具定义
- 调试和测试 API 端点
工具列表
getSwaggerDefinition
: 从 URL 下载 Swagger 定义listEndpoints
: 列出 Swagger 定义中的所有端点listEndpointModels
: 列出特定端点使用的所有模型generateModelCode
: 为模型生成 TypeScript 代码generateEndpointToolCode
: 为 MCP 工具定义生成 TypeScript 代码
常见问题解答
- 如何配置 Swagger-MCP?通过编辑
.env
文件进行配置。 - 如何运行 MCP 服务器?使用命令
node build/index.js
。 - 如何调试?使用
npm run inspector
运行 MCP 检查器。
使用教程
使用依赖
- Node.js (v14 或更高版本)
- npm 或 yarn
安装教程
- 克隆仓库:
git clone https://github.com/readingdancer/swagger-mcp.git
cd swagger-mcp - 安装依赖:
npm install
- 创建
.env
文件:
cp .env.example .env
- 更新
.env
文件。
调试方式
- 构建应用:
npm run build
- 运行 MCP 服务器:
node build/index.js
- 运行 MCP 检查器:
npm run inspector