Controlapi Openapi To MCP

🚀 ControlAPI-MCP

ControlAPI-MCPは、任意のOpenAPI/REST APIをMCPツールとして公開する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ツールを使用して動的に設定できます。

リリースからダウンロードするか、ビルドします:

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アシスタントがセットアップを案内します。

🔍 デバッグUI: 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. /auth/loginにexecute_requestを実行 → トークンを取得
3. set_variableでキー="token"、値="Bearer xyz..."を設定
4. Authorization: {{token}}でexecute_requestを実行
5. サーバーを切り替える: set_server_configで別の環境でテスト