Openapi MCP Proxy

🚀 OpenAPI MCP 服務器

一個命令行工具，能把任意 OpenAPI 服務轉換為 Model Context Protocol (MCP) 服務器，實現與 AI 代理及支持 MCP 規範工具的無縫集成。

🚀 快速開始

OpenAPI MCP 服務器是一款強大的命令行工具，可助力您輕鬆將 OpenAPI 服務轉化為 MCP 服務器。以下是快速上手的步驟：

安裝

npm install -g openapi-mcp-proxy

基本使用

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

✨ 主要特性

• 協議轉換：可將 OpenAPI 服務轉換為符合 MCP 標準的服務器，實現與 AI 代理和支持 MCP 規範的工具無縫集成。
• 自動生成：接受 OpenAPI 規範文件作為輸入，自動生成符合 MCP 標準的服務器。
• 請求代理：代理到實際 OpenAPI 服務的請求，並在 MCP 和 REST 約定之間進行轉換。

📚 詳細文檔

什麼是 Model Context Protocol (MCP)?

Model Context Protocol (MCP) 是一種標準化協議，用於 AI 代理與外部工具和服務之間的交互。它提供了一種統一的方式來發現、理解和利用各種能力，使構建能夠與多種服務交互的 AI 驅動應用程序變得更加簡單。

什麼是 OpenAPI?

OpenAPI（以前稱為 Swagger）是描述機器可讀接口文件的標準，用於定義、生成、消費和可視化 RESTful 網絡服務。它允許人類和計算機無需訪問源代碼或額外文檔即可發現和理解服務的功能。

關於該項目

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

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

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

🔧 技術細節

該項目主要實現了 OpenAPI 服務與 MCP 客戶端之間的交互，通過一系列步驟將 OpenAPI 服務轉換為 MCP 服務器：

1. 讀取 OpenAPI 規範文件，解析其中的接口信息。
2. 根據 MCP 標準生成對應的服務器代碼。
3. 當接收到 MCP 客戶端的請求時，將其轉換為符合 REST 約定的請求，並代理到實際的 OpenAPI 服務。
4. 將 OpenAPI 服務的響應轉換為 MCP 格式，返回給 MCP 客戶端。

📦 安裝指南

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

npm install -g openapi-mcp-proxy

💻 使用示例

基礎用法

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

高級用法

MCP 檢查工具

要測試您的 MCP 服務器，請執行以下操作：

1. 安裝檢查工具：npm install -g @merossai/mcpx
2. 啟動檢查工具：mcpx <your_api_key> http://localhost:3000

VS Code 中的配置

在 VS Code 中，您可以按 Ctrl+Shift+P 打開命令面板：

1. 輸入並選擇 "Remote-Containers: Start Server"
2. 配置代理設置：
   • 代理 URL: http://localhost:3000
   • 直接連接到目標端口: true

🤝 貢獻

歡迎為該項目做出貢獻！如果有任何問題或建議，請提交 問題 或 拉取請求。

📄 許可證

此項目受 MIT 許可證的保護。

⚠️ 重要提示

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