MCP

🚀 Vendure MCP Server

Vendure CLIのオーケストレーション用の独立したModel Context Protocol (MCP)サーバーです。このパッケージはプロジェクトごとに実行され、Cursorなどの外部クライアントが、ローカルのVendureプロジェクトのCLIコマンドとプログラム的かつコンテキストを考慮した方法でやり取りできるようにします。

✨ 主な機能

• プロジェクト統合：Vendureプロジェクト内で直接動作し、コンテキストを考慮したツールを提供します。
• CLI統合：Vendure CLIのaddおよびmigrateコマンドに直接アクセスできます。
• プロジェクト分析：プロジェクト構造を分析し、プラグイン、エンティティ、サービスをリストします。
• 双方向トランスポートサポート：Cursorなどのローカルクライアント用の標準入出力 (STDIO) またはネットワーククライアント用のHTTPを介して接続できます。
• 環境チェック：プロジェクト内のVendureインストールと依存関係を検証します。
• ドキュメントアクセス：MCPは、必要に応じて公式のVendureドキュメントを取得し、コンテキストとして使用できます。
• リアルタイム：ローカルのVendureプロジェクトを変更することなく動作します。

動的CLI統合

サーバーは、プロジェクトにインストールされたVendure CLIコマンド定義から動的にMCPツールを生成します。これにより、以下のことが保証されます。

• 単一の信頼できる情報源：CLIの変更が自動的にMCPツールに反映されます。
• 将来対応：新しいCLIコマンドとオプションが自動的に利用可能になります。
• 誤情報なし：ツールによって生成されるコードは、プロジェクト内の実際のCLI定義に基づいているため、常に正しくなります。

📦 インストール

⚠️ 重要提示

MCPのCLIコマンドオーケストレーション機能を使用するには、ターゲットプロジェクトが@vendure/cliパッケージのバージョン3.4.0以降を実行している必要があります。現在、これはマイナーブランチにあります。

パッケージのバージョンを変更するには、プロジェクトのpackage.jsonを開き、"@vendure/cli"のバージョンを"minor"に変更してから、package-lock.jsonファイルとnode_modulesフォルダを削除し、npm installを実行します。

サーバーは、Vendureプロジェクトから直接インストールして実行するように設計されています。これにより、常に正しい依存関係とプロジェクトコンテキストにアクセスできます。

MCPクライアントの設定（例：Cursor）

MCPクライアントで使用するmcp.jsonファイルを作成または更新します。このファイルは通常、プロジェクトのルートフォルダ内の.cursor/mcp.jsonにあります。

以下は、STDIOとHTTP接続の両方の設定です。

オプション1: STDIO接続（ローカルクライアントに推奨）

これは最も簡単で直接的な接続方法です。

{
    "mcpServers": {
        "vendure-local-mcp": {
            "command": "npx",
            "args": ["@vendure/mcp-server@latest", "--projectPath", "/path/to/your/vendure-project"]
        }
    }
}

⚠️ 重要提示

/path/to/your/vendure-projectをVendureプロジェクトのルートディレクトリの絶対パスに置き換える必要があります。

オプション2: HTTP接続

クライアントがSTDIOをサポートしていない場合、またはネットワークを介して接続する必要がある場合は、サーバーをHTTPモードで実行できます。

まず、Vendureプロジェクトのルートディレクトリでターミナルからサーバーを起動します。

npx @vendure/mcp-server@latest --transport http --projectPath .

これにより、デフォルトのポート (8000) でサーバーが起動します。--port <0000>フラグを使用してポートを明示的に定義することもできます。

次に、mcp.jsonを構成して、実行中のサーバーのURLに接続します。

{
    "mcpServers": {
        "vendure": {
            "url": "http://localhost:8000/mcp"
        }
    }
}

オプション3: Docker

これにより、Dockerコンテナが起動し、サーバーはstdioモードで実行されます。Dockerでの実行に関する詳細情報は、Dockerガイドを参照してください。

{
    "mcpServers": {
        "vendure-mcp-docker": {
            "command": "docker",
            "args": [
                "run",
                "--rm",
                "-i",
                "--env",
                "PROJECT_PATH=/workspace",
                "--volume",
                "/absolute/path/to-your-vendure-project:/workspace",
                "vendure/mcp:latest",
                "--projectPath",
                "/workspace"
            ]
        }
    }
}

⚠️ 重要提示

/path/to-your-vendure-projectをVendureプロジェクトのルートディレクトリの絶対パスに置き換える必要があります。

開発

Vendure MCPサーバー自体に貢献する場合は、ソースコードから実行する必要があります。

ソースからビルド

git clone https://github.com/vendure-ecommerce/mcp.git
cd vendure-mcp-server # または正しいディレクトリ名
npm install
npm run build

開発モード

MCPクライアントをローカルの開発サーバーに接続するには、npm run devスクリプトを使用し、テスト用のVendureプロジェクトを指定します。STDIOまたはHTTPモードのいずれかで実行できます。

• STDIOモード：npm run dev -- --projectPath /path/to/your/test-vendure-project
• HTTPモード：npm run dev:http -- --projectPath /path/to/your/test-vendure-project

セットアップセクションで説明されているように、mcp.jsonを構成して開発サーバーに接続します。--は、npmスクリプトに引数を正しく渡すために必要です。

トラブルシューティングと問題報告

MCPの使用中に問題が発生した場合、問題を再現するのに役立つ情報を含む問題報告をいただけると幸いです。

💡 使用建议

MCPクライアントによって作成されたMCPログを提供することができます。 Cursorでは、デフォルトでコマンドパレット (Shift+Cmd/Ctrl/Super+P) でDeveloper: Open Log File... > MCP Logsを探すことで見つけることができます。

リンク

• Vendure Core
• Vendure Documentation
• MCP Specification
• GitHub Repository