unity-mcp-for-server

unity-mcp-for-server

3.5
developer_tools

MCP Unity Editor is a project enabling the execution and management of MCP servers within Unity environments. It integrates Node.js capabilities into Unity, allowing users to start and debug servers efficiently. Key features include troubleshooting guides and multi-platform support for Windows and macOS.

MCP Unity エディター MCP PC (LLM)

要件

インストール

ステップ1: Node.jsをインストール

MCP Unityサーバーを実行するには、コンピューターにNode.js 18以降がインストールされている必要があります：

Windows
  1. Node.jsダウンロードページにアクセス
  2. LTSバージョンのWindowsインストーラー（.msi）をダウンロード（推奨）
  3. インストーラーを実行し、インストールウィザードに従う
  4. PowerShellを開いて以下を実行してインストールを確認： 
    node --version
macOS
  1. Node.jsダウンロードページにアクセス
  2. LTSバージョンのmacOSインストーラー（.pkg）をダウンロード（推奨）
  3. インストーラーを実行し、インストールウィザードに従う
  4. または、Homebrewがインストールされている場合は以下を実行： 
    brew install node@18
  5. ターミナルを開いて以下を実行してインストールを確認： 
    node --version

ステップ2: 手動設定

AIクライアントのMCP設定ファイル（例：Claude Desktopのclaude_desktop_config.json）を開き、以下のテキストをコピー：

{
  "mcpServers": {
    "mcp-unity": {
      "command": "node",
      "args": [
        "ABSOLUTE/PATH/TO/Server/build/index.js"
      ],
       "env": {
          "UNITY_HOST" : "YOUR_IP_ADDRESS",
          "UNITY_PORT" : "YOUR_PORT"
       }
    }
  }
}

サーバーの起動

MCP Unityサーバーを起動するには2つの方法があります：

オプション1: Unityエディター経由で起動

  1. Unityエディターを開く
  2. Tools > MCP Unity > Server Windowに移動
  3. "Start Server"ボタンをクリック

オプション2: コマンドラインから起動

  1. ターミナルまたはコマンドプロンプトを開く
  2. MCP Unityサーバーディレクトリに移動
  3. 以下のコマンドを実行： 
    node Server/build/index.js

サーバーのデバッグ

MCP Unityサーバーをデバッグするには、以下の方法を使用できます：

オプション1: Unityエディターを使用してデバッグ

  1. Unityエディターを開く
  2. Tools > MCP Unity > Server Windowに移動
  3. "Debug Server"ボタンをクリック

オプション2: コマンドラインを使用してデバッグ

  1. ターミナルまたはコマンドプロンプトを開く
  2. MCP Unityサーバーディレクトリに移動
  3. 以下のコマンドを実行： 
    npm run debug

トラブルシューティング

接続の問題
  • WebSocketサーバーが実行中であることを確認してください（UnityのServer Windowを確認）
  • ファイアウォールの制限が接続を妨げていないか確認してください
  • ポート番号が正しいことを確認してください（デフォルトは8080）
  • UnityエディターのMCP Serverウィンドウでポート番号を変更できます（ツール > MCP Unity > Server Window）
サーバーが起動しない
  • Unityコンソールにエラーメッセージがないか確認してください
  • Node.jsが正しくインストールされ、PATHで利用可能であることを確認してください
  • Serverディレクトリ内の依存関係がすべてインストールされていることを確認してください
Play Modeテスト実行時の接続失敗

run_tests ツールは以下の応答を返します：

Error:
Connection failed: Unknown error

このエラーは、Play Modeへ切り替える際にドメインリロードが発生し、ブリッジ接続が失われるために発生します。
回避策は、Edit > Project Settings > Editor > "Enter Play Mode Settings" で Reload Domain をオフにすることです。

ライセンス

本プロジェクトは の下で提供されています。

謝辞

貢献

貢献は大歓迎です！詳細についてはをお読みください。

ライセンス

このプロジェクトはMITライセンスの下でライセンスされています - 詳細はファイルを参照してください。

謝辞