Openapi Mcpserver Generator

🚀 OpenAPI から MCP サーバー生成器

このツールは、OpenAPI 仕様から Model Context Protocol (MCP) サーバーコードを生成するコマンドラインツールです。大型言語モデル (LLM) とあなたの API の間の橋渡しとして機能する MCP サーバーを迅速に作成するのに役立ちます。

English | 简体中文

🚀 クイックスタート

このツールを使って、OpenAPI 仕様から MCP サーバーを簡単に生成できます。以下の手順に従って操作してください。

基本的な使用法

1. まず、ツールをインストールします。

   npm install -g openapi-mcp-generator
   

2. 次に、生成器を実行します。

   oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server
   

3. 最後に、生成された MCP サーバーを起動します。

   cd mcp-server && npm start
   

高度な使用法

サポートされるセキュリティスキーム

OpenAPI 3.0 は 4 種類のセキュリティタイプをサポートしています。

• apiKey: 例:

    "securitySchemes": {
        "my_api_key": {
            "type": "apiKey",
            "name": "api_key",
            "in": "header"
        }
    }
  

  大文字の環境変数 MY_API_KEY_API_KEY を .env ファイルで指定する必要があります。

• http: 例:

    "securitySchemes": {
        basicAuth: {
           type: "http",
           scheme: "basic"
        }
    }
  

  .env ファイルから BASICAUTH_USERNAME と BASICAUTH_PASSWORD を取得します。

• oauth2: /oauth2/ の複雑さのため、自動的に処理することはできません。アクセストークンを手動で取得し、.env ファイルに次のように設定してください。

  API_HEADERS=Authorization:Bearer your-access-token-here
  

• openIdConnect 現時点ではサポートされていません。

カスタムログレベル

生成器でログレベルを指定することができます。

oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server --log-level debug

✨ 主な機能

• 自動ツール生成: OpenAPI 仕様の各 API エンドポイントを MCP ツールに変換します。
• 簡単なインストール: npm を使って簡単にインストールして実行できます。
• 強力な設定: OAuth2 や OpenID Connect など、複数のセキュリティスキームをサポートします。
• 柔軟なログ: ログレベルと出力形式をカスタマイズできます。

📦 インストール

npm install -g openapi-mcp-generator

📚 ドキュメント

最初のアイデア

このリポジトリは当初、openapi-mcp-generator からフォークされ、いくつかの追加機能が追加されました。

• OpenAPI 仕様のネストされた $ref をサポート
• ソースコードの生成に加え、MCP サーバー設定も生成
• クライアントがログレベルを設定し、ログメッセージを通知としてクライアントに送信できるようにする
• エラーが発生した場合、メッセージを stderr に送信する

📄 ライセンス

Apache 2.0