
Swagger MCP Server

2025.03.20
0
TypeScriptAPI 管理AI 代理集成开发效率
Swagger MCP Server 是一个基于 Model Context Protocol 的服务,用于将 Swagger/OpenAPI 定义的 API 通过 MCP 协议暴露给 AI 代理使用。它允许用户通过配置文件定义需要暴露的 Swagger 端点,从而简化 API 的访问和管理。
View on GitHub
Overview
基本能力
产品定位
Swagger MCP Server 是一个中间件服务,旨在将 Swagger/OpenAPI 定义的 API 通过 Model Context Protocol (MCP) 暴露给 AI 代理使用,便于 AI 代理访问和管理 API。
核心功能
- Swagger/OpenAPI 端点暴露:通过配置文件定义需要暴露的 Swagger 端点。
- MCP 协议支持:将 Swagger API 转换为 MCP 协议格式,供 AI 代理使用。
- 全局安装与直接运行:支持全局安装或通过
npx
直接运行。 - 配置灵活:支持通过 JSON 配置文件定义多个 Swagger 端点。
适用场景
- AI 代理集成:为 AI 代理提供标准化的 API 访问方式。
- API 管理:简化 Swagger/OpenAPI 的管理和暴露过程。
- 开发与测试:在开发和测试阶段快速暴露 API 供外部调用。
工具列表
- swagger-mcp-server:主服务工具,用于启动 MCP 服务并暴露 Swagger API。
- 能力:解析配置文件,启动 MCP 服务,暴露 Swagger API。
常见问题解答
- 如何定义多个 Swagger 端点?
- 在配置文件的
endpoints
数组中添加多个端点定义即可。 - 是否支持本地 Swagger 文件?
- 目前仅支持通过 URL 访问 Swagger JSON 定义。
使用教程
使用依赖
- 确保已安装 Node.js 和 npm。
安装教程
- 全局安装:
bash npm install -g swagger-mcp-server
- 或直接使用
npx
运行:bash npx swagger-mcp-server <config-file>
调试方式
- 运行服务后,可以通过日志查看服务状态:
bash swagger-mcp-server config.json
- 本地开发时,可以使用以下命令构建和运行:
bash npm run build npm run run