Openapi To Mcpserver

🚀 OpenAPI 到 MCP 轉換工具

本工具可將 OpenAPI 規範文件轉換為一個 MCP 服務器，該服務器能與現有由 OpenAPI 規範描述的 Web API 進行交互，從而讓 AI 代理或其他了解 MCP 的客戶端也能與這些 Web API 進行交互。

🚀 快速開始

本工具可將 OpenAPI 規範文件轉換為 MCP 服務器，便於 AI 代理或其他 MCP 客戶端與基於 OpenAPI 規範的 Web API 交互。以下是使用前的準備和操作步驟。

✨ 主要特性

• 🌟 自動將 OpenAPI 操作轉換為 MCP 工具。
• 🌐 支持現代流式 HTTP 和遺留 SSE 傳輸。
• 🎯 自動從 OpenAPI 規範中檢測 API 基礎 URL。
• 📐 支持 OpenAPI/Swagger 2.0 和 OpenAPI 3.x。
• 📦 處理二進制響應。
• ⏹️ 友好關閉處理。
• 🐞 詳細的日誌記錄以進行調試。

📦 安裝指南

先決條件

• Node.js（推薦 v16 或更高版本）

安裝步驟

1. 克隆倉庫（或確保你有 openapi-to-mcp 目錄）。
2. 進入 openapi-to-mcp 目錄：

   cd openapi-to-mcp
   

3. 安裝依賴項：

   npm install
   

🛠️ 構建說明

將 TypeScript 代碼編譯為 JavaScript：

npm run build

這將在項目中創建一個 dist 目錄，其中包含編譯後的 JavaScript 文件。

💻 使用示例

基礎用法

使用 start 腳本啟動服務器，並提供 OpenAPI 規範文件的路徑，使用 -f 或 --file 選項：

# 示例：使用本地 petstore.yaml 文件
npm start -- serve -f ./path/to/your/openapi.json

# 示例：指定不同端口和主機
npm start -- serve --file ./specs/petstore.json --port 9090 --host 0.0.0.0

注意：

• 將 ./path/to/your/openapi.json 替換為你實際的 OpenAPI 文件路徑。
• 服務器將解析文件，將 API 操作適配為 MCP 函數，並開始監聽。
• 它將打印出可供現代和遺留 MCP 連接使用的端點。

作為 MCP 客戶端連接

現代連接（推薦）

服務器提供由 MCP SDK 管理的現代流式 HTTP 傳輸，這是推薦的連接方式。

遺留 SSE 連接

為兼容舊版本，服務器還支持 SSE 連接：

1. 連接到 SSE 端點（例如 http://localhost:8080/sse）。

2. 連接時會收到一個 mcp-hello 事件。

3. 要調用函數，請向 /messages 端點發送 POST 請求，帶有一個 sessionId 查詢參數，與你的 SSE 連接 ID 匹配。

   示例：向 /messages?sessionId=<your_session_id> 發送 POST 請求

   頭部：

   Content-Type: application/json
   

   正文：

   {
     "type": "function_call",
     "id": "call-123",
     "function_name": "get_pets_by_status",
     "parameters": {
       "status": "available"
     }
   }
   

4. 服務器將執行相應的 API 調用，並通過已建立的 SSE 連接發送 function_return 或 error 事件。

開發模式

以開發模式運行，帶有自動重新編譯：

# 確保提供 OpenAPI 文件路徑
npm run dev -- -f ./path/to/your/openapi.yaml

📚 詳細文檔

當前限制

• 身份驗證：尚未實現。
• 模式驗證：雖然基本的模式驗證已到位，但某些複雜的 OpenAPI 模式功能（如區分器、複雜組合）可能不受完全支持。
• 測試：目前沒有包含自動化的測試。
• 文檔：單個工具文檔可以改進為更多示例和參數描述。