MCP Swagger 服务器

一个提供 Swagger/OpenAPI 文档访问并基于规范进行 API 请求的 MCP 服务器。

功能

• 从 URL 加载 Swagger 文档
• 基于 Swagger 规范进行 API 请求
• 支持通过 API 密钥进行身份验证
• 缓存 Swagger 规范以提高性能
• 验证请求是否符合 Swagger 规范

设置

1. 安装依赖项：

npm install

2. 构建 TypeScript 代码：

npm run build

本地运行

开发模式：

npm run dev

生产模式：

npm run start

配置

服务器需要以下环境变量：

• SWAGGER_URL：Swagger 规范的 URL（必需）
• AUTH_KEY：API 请求的身份验证密钥（可选）

可用资源和工具

资源：swagger-doc

• URI：swagger://documentation
• 描述：获取完整的 Swagger 文档

工具：makeRequest

基于 Swagger 规范进行 API 请求。

参数：

• path：API 端点路径
• method：HTTP 方法（GET、POST 等）
• parameters：可选的路径/查询参数
• body：可选的请求正文

示例：

const result = await mcp.tools.makeRequest({
  path: "/api/users",
  method: "GET",
  parameters: { userId: "123" }
});

Smithery.ai 部署

此服务器已配置为在 Smithery.ai 上部署。部署需要：

1. 包含构建和运行服务器的 Dockerfile
2. smithery.yaml 配置文件
3. 正确的 TypeScript 构建设置

配置方案

在 Smithery.ai 上配置服务器时，请使用以下内容：

{
  "swaggerUrl": "https://api.example.com/swagger.json",
  "authKey": "your-api-key"  // 可选
}

本地测试与 Smithery

1. 构建 Docker 镜像：

docker build -t mcp-swagger .

2. 运行容器：

docker run -e SWAGGER_URL=your-swagger-url -e AUTH_KEY=your-auth-key mcp-swagger

开发

脚本

• npm run build：构建 TypeScript 代码
• npm run start：以生产模式运行服务器
• npm run dev：以开发模式运行服务器，支持热重载