MCP Openapi Server

🚀 OpenAPI MCP 服務器

OpenAPI MCP 服務器是一個通過 OpenAPI 端點暴露為 MCP 資源的模型上下文協議（MCP）服務器。它允許大型語言模型藉助 MCP 協議，發現並與由 OpenAPI 規範定義的 REST API 進行交互。

🚀 快速開始

您無需克隆此倉庫即可使用此 MCP 服務器，只需在 Claude 桌面中進行如下配置：

1. 找到或創建 Claude 桌面配置文件：
   • 在 macOS 系統上，配置文件路徑為：~/Library/Application Support/Claude/claude_desktop_config.json
2. 添加配置以啟用 OpenAPI MCP 服務器：

{
  "mcpServers": {
    "openapi": {
      "command": "npx",
      "args": ["-y", "@ivotoby/openapi-mcp-server"],
      "env": {
        "API_BASE_URL": "https://api.example.com",
        "OPENAPI_SPEC_PATH": "https://api.example.com/openapi.json",
        "API_HEADERS": "Authorization:Bearer token123,X-API-Key:your-api-key"
      }
    }
  }
}

3. 替換環境變量為實際 API 配置：
   • API_BASE_URL：API 的基礎 URL
   • OPENAPI_SPEC_PATH：OpenAPI 規範的 URL 或路徑
   • API_HEADERS：用於 API 身份驗證的逗號分隔鍵值對

✨ 主要特性

此項目包含多種開發工具，可簡化工作流程，具體如下：

構建

• npm run build：編譯 TypeScript 源代碼
• npm run clean：刪除構建 artifacts
• npm run typecheck：運行 TypeScript 類型檢查

開發模式

• npm run dev：監視源文件並在更改時重建
• npm run inspect-watch：運行 inspector 並在更改時自動重新加載

代碼質量

• npm run lint：運行 ESLint
• npm run typecheck：驗證 TypeScript 類型

📦 安裝指南

服務器可通過環境變量或命令行參數進行配置：

環境變量

• API_BASE_URL：API 端點的基礎 URL
• OPENAPI_SPEC_PATH：OpenAPI 規範的路徑或 URL
• API_HEADERS：用於 API 頭的逗號分隔鍵值對
• SERVER_NAME：MCP 服務器的名稱（默認： "mcp-openapi-server"）
• SERVER_VERSION：服務器版本（默認： "1.0.0"）

命令行參數

npm run inspect -- \
  --api-base-url https://api.example.com \
  --openapi-spec https://api.example.com/openapi.json \
  --headers "Authorization:Bearer token123,X-API-Key:your-api-key" \
  --name "my-mcp-server" \
  --version "1.0.0"

💻 使用示例

開發工作流程

1. 啟動開發環境：

npm run inspect-watch

2. 對 src/ 中的 TypeScript 文件進行更改
3. 服務器會自動重建並重新啟動
4. 使用 MCP Inspector UI 測試更改

調試

服務器將調試日誌輸出到標準錯誤流，查看日誌的方法如下：

1. 在開發模式下：日誌會在運行 inspect-watch 的終端中顯示。
2. 直接運行時：

npm run inspect 2>debug.log

📚 詳細文檔

貢獻流程

1. Fork 倉庫
2. 創建功能分支
3. 進行更改
4. 運行測試和 linting：

npm run typecheck
npm run lint

5. 提交拉取請求

📄 許可證

本項目採用 MIT 許可證。