MCP Swagger Server

🚀 MCP Swagger 服務器

MCP Swagger 服務器可提供 Swagger/OpenAPI 文檔訪問服務，並能依據規範發起 API 請求，為開發者提供便捷的 API 交互體驗。

✨ 主要特性

• 可從 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：以開發模式運行服務器，支持熱重載