Skip to content

Latest commit

 

History

History
271 lines (198 loc) · 13.8 KB

README-ja.md

File metadata and controls

271 lines (198 loc) · 13.8 KB

MCP Unity エディター (ゲームエンジン)

smithery badge

English 🇨🇳简体中文 🇯🇵日本語 
                              ,/(/.   *(/,                                  
                          */(((((/.   *((((((*.                             
                     .*((((((((((/.   *((((((((((/.                         
                 ./((((((((((((((/    *((((((((((((((/,                     
             ,/(((((((((((((/*.           */(((((((((((((/*.                
            ,%%#((/((((((*                    ,/(((((/(#&@@(                
            ,%%##%%##((((((/*.             ,/((((/(#&@@@@@@(                
            ,%%######%%##((/(((/*.    .*/(((//(%@@@@@@@@@@@(                
            ,%%####%#(%%#%%##((/((((((((//#&@@@@@@&@@@@@@@@(                
            ,%%####%(    /#%#%%%##(//(#@@@@@@@%,   #@@@@@@@(                
            ,%%####%(        *#%###%@@@@@@(        #@@@@@@@(                
            ,%%####%(           #%#%@@@@,          #@@@@@@@(                
            ,%%##%%%(           #%#%@@@@,          #@@@@@@@(                
            ,%%%#*              #%#%@@@@,             *%@@@(                
            .,      ,/##*.      #%#%@@@@,     ./&@#*      *`                
                ,/#%#####%%#/,  #%#%@@@@, ,/&@@@@@@@@@&\.                    
                 `*#########%%%%###%@@@@@@@@@@@@@@@@@@&*´                   
                    `*%%###########%@@@@@@@@@@@@@@&*´                        
                        `*%%%######%@@@@@@@@@@&*´                            
                            `*#%%##%@@@@@&*´                                 
                               `*%#%@&*´                                     
                                                        
     ███╗   ███╗ ██████╗██████╗         ██╗   ██╗███╗   ██╗██╗████████╗██╗   ██╗
     ████╗ ████║██╔════╝██╔══██╗        ██║   ██║████╗  ██║██║╚══██╔══╝╚██╗ ██╔╝
     ██╔████╔██║██║     ██████╔╝        ██║   ██║██╔██╗ ██║██║   ██║    ╚████╔╝ 
     ██║╚██╔╝██║██║     ██╔═══╝         ██║   ██║██║╚██╗██║██║   ██║     ╚██╔╝  
     ██║ ╚═╝ ██║╚██████╗██║             ╚██████╔╝██║ ╚████║██║   ██║      ██║   
     ╚═╝     ╚═╝ ╚═════╝╚═╝              ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝      ╚═╝

MCP Unityは、Unityエディター向けのModel Context Protocolの実装であり、AIアシスタントがUnityプロジェクトと対話できるようにします。このパッケージは、UnityとMCPプロトコルを実装するNode.jsサーバー間のブリッジを提供し、Claude、Windsurf、CursorなどのAIエージェントがUnityエディター内で操作を実行できるようにします。

機能

Unity MCPサーバー

IDE統合 - パッケージキャッシュアクセス

MCP Unityは、UnityのLibrary/PackedCacheフォルダーをワークスペースに追加することで、VSCode系IDE（Visual Studio Code、Cursor、Windsurf）との自動統合を提供します。この機能により：

  • Unityパッケージのコードインテリジェンスが向上
  • Unityパッケージのより良いオートコンプリートと型情報が有効化
  • AIコーディングアシスタントがプロジェクトの依存関係を理解するのに役立つ

MCPサーバーツール

  • execute_menu_item: Unityメニュー項目（MenuItem属性でタグ付けされた関数）を実行

    例: "新しい空のGameObjectを作成するためにメニュー項目'GameObject/Create Empty'を実行"

  • select_gameobject: パスまたはインスタンスIDでUnity階層内のゲームオブジェクトを選択

    例: "シーン内のMain Cameraオブジェクトを選択"

  • update_component: GameObject上のコンポーネントフィールドを更新、またはGameObjectに含まれていない場合は追加

    例: "PlayerオブジェクトにRigidbodyコンポーネントを追加し、その質量を5に設定"

  • add_package: Unityパッケージマネージャーに新しいパッケージをインストール

    例: "プロジェクトにTextMeshProパッケージを追加"

  • run_tests: Unityテストランナーを使用してテストを実行

    例: "プロジェクト内のすべてのEditModeテストを実行"

  • notify_message: Unityエディターにメッセージを表示

    例: "タスクが完了したことをUnityに通知"

  • add_asset_to_scene: AssetDatabaseからアセットをUnityシーンに追加

    例: "プロジェクトからPlayerプレハブを現在のシーンに追加"

MCPサーバーリソース

  • unity://menu-items: execute_menu_itemツールを容易にするために、Unityエディターで利用可能なすべてのメニュー項目のリストを取得

    例: "GameObject作成に関連する利用可能なすべてのメニュー項目を表示"

  • unity://hierarchy: Unity階層内のすべてのゲームオブジェクトのリストを取得

    例: "現在のシーンの階層構造を表示"

  • unity://gameobject/{id}: シーン階層内のインスタンスIDまたはオブジェクトパスで特定のGameObjectに関する詳細情報を取得

    例: "Player GameObjectに関する詳細情報を取得"

  • unity://logs: Unityコンソールからのすべてのログのリストを取得

    例: "Unityコンソールからの最近のエラーメッセージを表示"

  • unity://packages: Unityパッケージマネージャーからインストール済みおよび利用可能なパッケージに関する情報を取得

    例: "Unityプロジェクトに現在インストールされているすべてのパッケージをリスト"

  • unity://assets: Unityアセットデータベース内のアセットに関する情報を取得

    例: "プロジェクト内のすべてのテクスチャアセットを検索"

  • unity://tests/{testMode}: Unityテストランナー内のテストに関する情報を取得

    例: "Unityプロジェクトで利用可能なすべてのテストをリスト"

要件

インストール

このMCP Unityサーバーのインストールは複数ステップのプロセスです：

ステップ1: Unityパッケージマネージャー経由でUnity MCPサーバーパッケージをインストール

  1. Unityパッケージマネージャーを開く（Window > Package Manager）
  2. 左上隅の"+"ボタンをクリック
  3. "Add package from git URL..."を選択
  4. 入力: https://github.com/CoderGamester/mcp-unity.git
  5. "Add"をクリック

package manager

ステップ2: 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

ステップ3: AI LLMクライアントを設定

オプション1: Unityエディターを使用して設定
  1. Unityエディターを開く
  2. Tools > MCP Unity > Server Windowに移動
  3. 以下の画像のようにAI LLMクライアントの"Configure"ボタンをクリック

image

  1. 表示されるポップアップで設定インストールを確認

image

オプション2: Smithery経由で設定

Smithery経由でMCP Unityをインストール：

現在利用不可
オプション3: 手動設定

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

ABSOLUTE/PATH/TOをMCP Unityインストールの絶対パスに置き換えるか、UnityエディターMCPサーバーウィンドウ（Tools > MCP Unity > Server Window）からテキストをコピー

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

サーバーの起動

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

トラブルシューティング

よくある問題

サーバーが起動しない

  • Node.js 18以降がインストールされていることを確認
  • npm 9以降がインストールされていることを確認
  • MCP Unityサーバーディレクトリが正しいことを確認

メニュー項目が実行されない

  • メニュー項目のパスが正しいことを確認（大文字小文字を区別）
  • メニュー項目が確認を必要とするかどうかを確認
  • メニュー項目が現在のコンテキストで利用可能であることを確認

貢献

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

ライセンス

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

謝辞