Openapi Proxy

🚀 OpenAPI MCP 服務器

一個命令行工具，可將任意 OpenAPI 服務轉換為 Model Context Protocol (MCP) 服務器，實現與 AI 代理和支持 MCP 規範的工具之間的無縫集成，讓服務使用更便捷。

⚠️ 重要提示

此工具仍處於早期開發階段。開發路線圖在此

🚀 快速開始

本工具可將任意 OpenAPI 服務轉換為 MCP 服務器，實現與 AI 代理和支持 MCP 規範的工具無縫集成。下面為你介紹詳細的安裝和使用方法。

✨ 主要特性

• 接收 OpenAPI 規範文件作為輸入，自動生成符合 MCP 標準的服務器。
• 代理到實際 OpenAPI 服務的傳入請求，在 MCP 和 REST 約定之間進行轉換。
• 讓任何具有 OpenAPI 規範的現有 REST API 能立即對理解 MCP 的 AI 代理可用，無需修改原始服務。

📦 安裝指南

使用以下命令進行全局安裝：

npm install -g openapi-mcp-proxy

💻 使用示例

基礎用法

使用以下命令啟動 MCP 服務器：

npx openapi-mcp-proxy --spec ./path/to/openapi.yml --target http://your-api.com --port 3000

選項說明

• -s, --spec <路徑>（必需）：OpenAPI 規範文件的路徑（環境變量：OMP_OPENAPI_SPEC_FILE）
• -t, --target <URL>（可選）：目標 API 服務 URL（默認：http://localhost:8080，環境變量：OMP_TARGET_BASE_URL）
• -p, --port <數字>（可選）：運行 MCP 服務器的端口（默認：3000，環境變量：PORT）
• -V, --version：顯示版本號
• -h, --help：顯示幫助信息

示例

啟動 Petstore API 的 MCP 服務器：

npx openapi-mcp-proxy --spec resources/petstore.openapi.yml --target https://petstore.swagger.io/v2

📚 詳細文檔

什麼是 Model Context Protocol (MCP)?

模型上下文協議（MCP）是 AI 代理與外部工具和服務交互的標準協議。它為 AI 模型提供了一種統一的方式來發現、理解並利用各種功能，從而簡化了構建支持多個服務的 AI 驅動應用程序的過程。

什麼是 OpenAPI?

OpenAPI（原名為 Swagger）是一項機器可讀接口文件規範，用於描述、生成、消費和可視化 RESTful 網絡服務。它使人類和計算機能夠無需訪問源代碼或額外文檔即可發現和理解服務的功能。

關於該項目

此中間件作為 OpenAPI 服務與 MCP 客戶端之間的橋樑：

1. 接收 OpenAPI 規範文件作為輸入
2. 自動生成符合 MCP 標準的服務器
3. 代理到實際 OpenAPI 服務的傳入請求
4. 在 MCP 和 REST 約定之間進行轉換

這使得任何具有 OpenAPI 規範的現有 REST API 能立即對理解 MCP 的 AI 代理可用，而無需修改原始服務。

測試

MCP 檢查器

要測試你的 MCP 服務器，可以使用 Model Context Protocol Inspector：

1. 安裝 MCP 檢查器：

npx @modelcontextprotocol/inspector

2. 啟動你的 MCP 服務器
3. 打開檢查器的界面並輸入正確的服務器路徑（以 /mcp 結尾），例如 http://localhost:3000/mcp
4. 現在你可以通過 MCP 檢查器與你的 MCP 服務器交互。檢查器會顯示請求和響應的詳細信息。

VS Code 使用方法

1. 打開 VS Code 並安裝 MCP 代理 插件。
2. 啟動 MCP 服務器後，通過以下步驟配置代理：
   • 點擊右下角的代理圖標
   • 選擇 "Add Proxy"
   • 填寫代理名稱和地址（例如 http://localhost:3000）
3. 在你的項目中設置代理配置文件（如 .mcp-proxy.json）：

{
  "proxies": {
    "my-api": {
      "target": "https://petstore.swagger.io/v2",
      "proxyUrl": "http://localhost:3000"
    }
  }
}

📄 許可證

該項目遵循 MIT 許可證。更多信息請參見 LICENSE 文件。