MCP Unity

🚀 Unity MCP プロトコル統合ガイド

このガイドは、Unity での MCP プロトコルの統合方法を説明します。MCP プロトコルを使用することで、モデルコンテキストの管理が容易になります。

🚀 クイックスタート

このセクションでは、Unity MCP プロトコルの統合を迅速に開始するための手順を説明します。

📦 インストール

コードの取得

1. Git を使用してリポジトリをクローンします。

   git clone https://github.com/CoderGamester/mcp-unity.git
   cd mcp-unity
   

2. Unity で以下のパッケージを Assets/Package Manager にインポートします。

   • Model Context Protocol
   • WebSocketSharp

📚 ドキュメント

プロジェクト構造

mcp-unity/
├── Assets/             # Unity プロジェクトのアセット
│   ├── Editor/         # MCP エディタースクリプト
│   └── PackageManager/ # パッケージ管理の設定ファイル
├── Server/            # Node.js サーバーコード
│   ├── src/           # ソースコードフォルダ
│   │   ├── index.ts    # エントリーファイル
│   │   └── server.ts   # サーバーロジック
│   └── build/         # コンパイル出力フォルダ
├── .env                # 環境変数設定
└── README.md          # 使用ドキュメント

実行方法

クイックスタート

1. Unity エディターを起動し、MCP コンポーネントが有効になっていることを確認します。
2. Node.js サーバーを起動します。

   cd ABSOLUTE/PATH/TO/mcp-unity/Server
   npm install && node build/index.js
   

設定ガイド

環境変数の設定

ルートディレクトリに .env ファイルを作成または編集し、以下の設定を追加します。

LOGGING=true
LOGGING_FILE=false
PORT=8090

サーバーパラメータ

コマンドラインで追加のパラメータを渡すことができます。

# ログレベルを設定する
--logLevel debug

# リモートデバッグを有効にする
--enableRemoteDebugging

実行時設定

MCP プロトコルバージョン

以下のプロトコルバージョンがサポートされています。

• v1.0.0
• v1.1.0（最新版）

ネットワーク設定

1. WebSocket サーバーのアドレスを設定します。

   ws://localhost:8090
   

2. HTTP インターフェースのエンドポイントを設定します。

   "/api/v1"
   

デバッグガイド

ソースコードのデバッグ

Server/src ディレクトリでブレークポイントを設定し、デバッグプログラムを起動します。

ログ出力

コンソールログを有効にするには、以下のコマンドを実行します。

set LOGGING=true & set LOGGING_FILE=false

トラブルシューティング

接続問題

• WebSocket サーバーが起動していることを確認します。
• ファイアウォールの設定を確認し、ポートが開いていることを確認します。
• 接続アドレスとポートの設定が正しいことを確認します。

起動失敗

• Unity コンソールのエラーメッセージを確認します。
• Node.js が正しくインストールされ、PATH に追加されていることを確認します。
• 依存パッケージのバージョン要件を確認します。

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

問題報告

• GitHub に Issue を投稿してください。
• support@mcprotocol.com にメールを送信してください。

コミュニティディスカッション

以下のコミュニティで議論に参加できます。

• Unity 公式フォーラム
• MCP プロトコル技術グループ

付録

よくある質問

1. MCP バージョンをアップグレードするにはどうすればいいですか？

   • パッケージマネージャーで更新オプションを選択します。

2. Node.js サーバーが起動しない場合はどうすればいいですか？

   • npm パッケージが正常にインストールされていることを確認します。
   • Node.js のバージョンが要件を満たしていることを確認します（>=14.x）。

3. ログ出力を無効にするにはどうすればいいですか？

   • .env ファイルで LOGGING=false を設定します。

用語集

• MCP：Model Context Protocol、モデルコンテキストプロトコル
• WebSocket：リアルタイム通信プロトコル
• npm：Node パッケージ管理ツール

📄 ライセンス

このプロジェクトは MIT オープンソースライセンスに従います。

MIT License

Copyright (c) 2023 CoderGamester

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.