Ivo Toby MCP Openapi Server

🚀 OpenAPI MCP 服務器

OpenAPI MCP 服務器基於 Model Context Protocol (MCP)，通過 OpenAPI 端點提供 MCP 資源。它允許大型語言模型藉助 MCP 協議，發現並與由 OpenAPI 規範定義的 REST API 進行交互。

🚀 快速開始

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

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

{
  "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_BASE_URL：API 的基礎 URL
   • OPENAPI_SPEC_PATH：OpenAPI 規範的路徑或 URL
   • API_HEADERS：用於 API 身份驗證的鍵值對，以逗號分隔

✨ 主要特性

• 允許大型語言模型通過 MCP 協議與 OpenAPI 規範定義的 REST API 進行交互。
• 無需克隆倉庫，可直接在 Claude Desktop 中配置使用。

📦 安裝指南

無需克隆倉庫，在 Claude Desktop 中按上述快速開始部分的步驟進行配置即可使用。

💻 使用示例

基礎用法

在 Claude Desktop 中配置服務器的示例代碼如下：

{
  "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"
      }
    }
  }
}

🔧 技術細節

開發工具

此項目包含多個開發工具，可簡化工作流程：

構建

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

開發模式

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

代碼質量

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

配置

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

環境變量

命令行參數

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 檢查儀 UI 測試您的更改。

調試

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

1. 在開發模式下，日誌在運行 inspect-watch 的終端中顯示。
2. 直接運行時，使用以下命令將日誌輸出到 debug.log 文件：

npm run inspect 2>debug.log

🤝 貢獻

1. 分叉倉庫。
2. 創建功能分支。
3. 進行更改。
4. 運行測試和代碼檢查：

npm run typecheck
npm run lint

5. 提交拉取請求。