swagg-mcp工具
什么是swagg-mcp工具
MCP（模型上下文协议）服务器，加载Swagger/OpenAPI文档，并为AI助手和MCP客户端提供查询工具。
特性
- 使用Swagger文档通过代理直接生成与API相关的代码。
- 为TypeScript项目生成响应类型和接口定义。
安装
先决条件
- Node.js>=18
- npm或npx（用于运行CLI）
- Bun>=1.0.0（可选，用于开发/构建）
安装
npm install -g swagger-mcp-tool用法
将一个或多个服务器条目添加到MCP客户端配置中（例如Cursor： ~/.cursor/mcp.json).为每个Swagger/OpenAPI文档使用单独的服务器名称，以并行支持多个项目。
{
"mcpServers": {
"swagger-petstore": {
"command": "npx",
"args": ["-y", "swagger-mcp-tool", "https://example.com/petstore.json"]
},
"swagger-orders": {
"command": "npx",
"args": ["-y", "swagger-mcp-tool", "./openapi/orders.yaml"]
}
}
}聊天面板示例
配置服务器后，描述您想在聊天面板中添加什么。从“查看Swagger文档”开始，帮助代理触发此工具，例如：
“查看Swagger文档并完成订单域的退款API。”
API
| 工具 | 描述 | 参数 | 输出 |
|---|---|---|---|
list_api_groups | 列出所有API组（标记） | 无 | 标记对象的JSON数组 |
search_apis | 按标签或关键字搜索API | tag （可选）， keyword （可选） | API摘要的JSON数组 |
get_api_detail | 获取完整的操作细节 | path, method | JSON操作对象 |
get_schema | 通过以下方式获取架构 $ref 或姓名 | ref | JSON模式对象 |
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。