Openapi MCP Server

🚀 OpenAPI MCP サーバー

このプロジェクトは、LLMのコンテキストとして構成済みのREST APIを提供する MCP - Model Context Protocol Server をインストールします。このサーバーを使用することで、LLMとREST APIのやり取りを有効にし、LLMの指示によってREST API呼び出しを実行できます。現在は GET/PUT/POST/PATCH のHTTPリクエストメソッドがサポートされています。

🚀 クイックスタート

このセクションでは、OpenAPI MCPサーバーの基本的な使い方を説明します。

📦 インストール

インストールパッケージ

pip install openapi_mcp_server

環境変数の設定

フォルダ内に .env ファイルを作成し、OPENAPI_SPEC_PATH と API_BASE_URL を設定する必要な値を設定します。サンプルファイルは ここ からダウンロードできます。

サーバーのテスト

uv run openapi_mcp_server

💻 使用例

基本的な使用法

Claud デスクトップの設定例

{
    "mcpServers": {
        "openapi_mcp_server": {
            "command": "uv",
            "args": ["run", "openapi_mcp_server"],
            "env": {
                "DEBUG": "1",
                "API_BASE_URL": "https://petstore.swagger.io/v2",
                "OPENAPI_SPEC_PATH": "https://petstore.swagger.io/v2/swagger.json",
                "API_HEADERS": "Accept:application/json",
                "API_WHITE_LIST": "addPet,updatePet,findPetsByStatus"
            }
        }
    }
}

高度な使用法

環境変数の設定

📚 ドキュメント

UVコマンドの説明

mkdir -m777 openapi_mcp_server
cd openapi_mcp_server
uv init
uv add mcp プロトコル プロトコル、プロトコル、プロトコル
uv sync
uv run
uv build

• uv init：プロジェクトを初期化します。
• uv add [依存関係...]：必要な依存関係を追加します。例えば、uv add openapi-spec プロトコル を実行すると、OpenAPI関連の依存関係が自動的に追加される場合があります。
• uv sync：コードを同期します。
• uv run：サーバーを実行します。
• uv build：プロジェクトをビルドします。

これらのコマンドにより、開発者はMCPサーバーを迅速に初期化、構成、およびデプロイでき、すべての依存関係が正しくインストールされ、コードが最新の状態に保たれます。これにより、ユーザーはサーバーを既存の開発環境に簡単に統合し、さらにカスタマイズや拡張を行うことができます。

🤝 貢献

貢献は大歓迎です。自由にPull Requestを送信してください。

📄 ライセンス

このプロジェクトはMITライセンスの条項に基づいてライセンスされています。

⭐ GitHubスター

📞 フィードバックとサポート

使用中に問題が発生した場合や、さらなるサポートが必要な場合は、プロジェクトドキュメントを参照するか、メンテナに連絡してください。あなたのフィードバックは、私たちがプロジェクトを改善するために非常に貴重です！