Controlapi Openapi To MCP

🚀 ControlAPI-MCP

ControlAPI-MCP 是一個 MCP 服務器，它能將任何 OpenAPI/REST API 轉換為 MCP 工具，支持動態服務器切換和變量替換。

🚀 快速開始

📦 安裝指南

一鍵安裝

可直接在編輯器中點擊安裝，無需任何配置！

• Linux / macOS：
  • 📥 在 VS Code 中安裝
  • 📥 在 VS Code Insiders 中安裝

💡 安裝後：AI 助手會引導你連接到 API 服務器。當被詢問時，只需提供 OpenAPI URL，或使用 set_server_config 工具連接到你的 API。

自動下載快速啟動

零安裝，自動下載並運行最新版本：

1. 下載自動運行腳本：

curl -O https://raw.githubusercontent.com/fellowabhi/ControlAPI-openapi-to-mcp/main/auto-run.sh
chmod +x auto-run.sh

2. 在你的 MCP 配置中使用：

{
  "servers": {
    "controlapi-mcp": {
      "type": "stdio",
      "command": "/path/to/auto-run.sh"
    }
  }
}

注意：你可以選擇在環境變量中設置 OPENAPI_URL、BASE_URL 和 SERVER_NICKNAME，或者使用 set_server_config 工具進行動態配置。

也可以從 releases 下載或自行構建：

export OPENAPI_URL='http://your-api.com/openapi.json'
export BASE_URL='http://your-api.com'  # 可選
./dist/controlapi-mcp

開發環境設置

pip install -e .

構建二進制文件

./build.sh

會在 dist/controlapi-mcp 生成一個獨立的可執行文件（16MB）。

MCP 配置

使用二進制文件

{
  "servers": {
    "controlapi-mcp": {
      "type": "stdio",
      "command": "/path/to/openapi-mcp-adapter/dist/controlapi-mcp",
      "env": {
        "OPENAPI_URL": "http://localhost:8000/openapi.json",
        "BASE_URL": "http://localhost:8000",
        "DEBUG_PORT": "45133"
      }
    }
  }
}

使用 Python（開發環境）

{
  "servers": {
    "controlapi-mcp": {
      "type": "stdio",
      "command": "/path/to/project/.venv/bin/python",
      "args": ["-m", "src.main"],
      "cwd": "/path/to/project",
      "env": {
        "OPENAPI_URL": "http://localhost:8000/openapi.json",
        "REFRESH_INTERVAL": "300",
        "PYTHONPATH": "/path/to/project",
        "BASE_URL": "http://localhost:8000",
        "DEBUG_PORT": "45133"
      }
    }
  }
}

可選參數：OPENAPI_URL、BASE_URL、SERVER_NICKNAME、DEBUG_PORT（默認值：45133）

💡 無需配置：你可以在不設置環境變量的情況下啟動，然後使用 set_server_config 工具動態配置服務器。AI 助手會引導你完成設置。 🔍 調試界面：可在 http://localhost:45133（或自定義的 DEBUG_PORT）訪問基於瀏覽器的請求/響應監視器。URL 可在 get_server_info 的響應中獲取。

✨ 主要特性

跨平臺支持

• Linux (x86_64) - 完全支持
• macOS (Intel & Apple Silicon) - 完全支持
• Windows - 使用 Python 或 WSL

動態服務器切換

• 在運行時連接到任何 OpenAPI 服務器
• 在多個 API（開發、測試、生產環境）之間切換
• 跟蹤服務器上下文並記錄歷史
• 自動重新加載模式

可用工具

• set_server_config - 連接到 OpenAPI 服務器（如果未配置，先使用此工具）
• get_server_info - 檢查當前服務器和連接狀態
• get_server_history - 查看最近的服務器切換記錄
• health_check - 測試服務器連接性
• list_endpoints - 列出所有 API 端點
• search_schema - 按關鍵字搜索端點
• execute_request - 進行 HTTP 請求並支持變量替換
• set_variable - 存儲變量（如認證令牌）
• get_variables - 查看所有存儲的變量
• reload_schema - 重新加載當前服務器的模式

💻 使用示例

變量替換

在請求頭、請求體或路徑中使用 {{variable_name}}：

{
  "headers": {
    "Authorization": "{{token}}"
  }
}

示例工作流

1. 首次使用：使用 set_server_config 並提供 openapi_url
2. 執行 execute_request 到 /auth/login 獲取令牌
3. 使用 set_variable 存儲令牌，如 key="token" value="Bearer xyz..."
4. 執行 execute_request 並在請求頭中使用 Authorization: {{token}}
5. 切換服務器：使用 set_server_config 在不同環境中進行測試