Unity MCP Server

by justinpbarnett
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Provides comprehensive control over the Unity Editor, enabling programmatic manipulation of assets, scene management, material editing, script creation/editing, and automation of editor functions like undo, play, and build.

ユニティMCP✨

モデルコンテキストプロトコルを使用して Unity エディターを LLM に接続します。

Unity MCPはブリッジとして機能し、AIアシスタント(Claude、Cursorなど)がローカルMCP(Model Context Protocol)クライアントを介してUnityエディターと直接やり取りできるようにします。LLMツールにアセット管理、シーン制御、スクリプト編集、Unity内のタスク自動化などの機能を提供します。


主な機能🚀

  • 🗣️ 自然言語制御: LLM に Unity タスクを実行するように指示します。
  • **🛠️ 強力なツール:**アセット、シーン、マテリアル、スクリプト、エディター機能を管理します。
  • **🤖 自動化:**反復的な Unity ワークフローを自動化します。
  • **🧩 拡張可能:**さまざまな MCP クライアントで動作するように設計されています。

LLM では次のような機能を使用できます:

  • read_console : コンソールからメッセージを取得したり、コンソールをクリアしたりします。
  • manage_script : C# スクリプト (作成、読み取り、更新、削除) を管理します。
  • manage_editor : エディターの状態と設定を制御および照会します。
  • manage_scene : シーンを管理します (読み込み、保存、作成、階層の取得など)。
  • manage_asset : アセット操作 (インポート、作成、変更、削除など) を実行します。
  • manage_gameobject : GameObject を管理します (作成、変更、削除、検索、コンポーネント操作)。
  • execute_menu_item : パスを介してメニュー項目を実行します (例: 「ファイル/プロジェクトの保存」)。

仕組み🤔

Unity MCP は、次の 2 つのコンポーネントを使用してツールを接続します。

  1. **Unity MCP Bridge:**エディター内で実行される Unity パッケージ。(パッケージ マネージャー経由でインストールされます)。
  2. **Unity MCP サーバー:**ローカルで実行され、Unity ブリッジと MCP クライアント間で通信する Python サーバー。(手動でインストール)

フロー: [Your LLM via MCP Client] <-> [Unity MCP Server (Python)] <-> [Unity MCP Bridge (Unity Editor)]


インストール⚙️

**注:**パッケージのアップデートに伴い、セットアップは常に改善されています。問題が発生した場合は、再度ご確認ください。

前提条件

ステップ1:Unityパッケージ(ブリッジ)をインストールする

  1. Unity プロジェクトを開きます。
  2. Window > Package Managerに移動します。
  3. + -> Add package from git URL...クリックします。
  4. 入力:
    https://github.com/justinpbarnett/unity-mcp.git?path=/UnityMcpBridge
  5. Addクリックします。
  6. このプロセスの結果、MCP サーバーがマシンに自動的にインストールされます。

ステップ2: MCPクライアントを構成する

MCP クライアント (Claude、Cursor など) を手順 1 でインストールした Python サーバーに接続します。

オプション A: 自動構成 (Claude/Cursor に推奨)

  1. Unity で、 Window > Unity MCPに移動します。
  2. Auto Configure ClaudeまたはAuto Configure Cursorをクリックします。
  3. 緑色のステータスインジケーター 🟢 と「接続済み」を確認します。 (これにより、MCP クライアントの構成ファイルが自動的に変更されます)

オプションB: 手動設定

自動構成が失敗した場合、または別のクライアントを使用する場合:

  1. MCP クライアントの構成ファイルを見つけます。 (クライアントのドキュメントを確認してください)。
    • Claude の例 (macOS): ~/Library/Application Support/Claude/claude_desktop_config.json
    • Claude の例 (Windows): %APPDATA%\Claude\claude_desktop_config.json
  2. 手順 1 の正確なパスを使用して、ファイルを編集しmcpServersセクションを追加/更新します。

ウィンドウズ:

{ "mcpServers": { "UnityMCP": { "command": "uv", "args": [ "run", "--directory", "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Programs\\UnityMCP\\UnityMcpServer\\src", "server.py" ] } // ... other servers might be here ... } }

(YOUR_USERNAME を置き換えて二重のバックスラッシュ \ を使用することを忘れないでください)

macOS:

{ "mcpServers": { "UnityMCP": { "command": "uv", "args": [ "run", "--directory", "/usr/local/bin/UnityMCP/UnityMcpServer/src", "server.py" ] } // ... other servers might be here ... } }

(~/bin を使用する場合は YOUR_USERNAME を置き換えてください)

リナックス:

{ "mcpServers": { "UnityMCP": { "command": "uv", "args": [ "run", "--directory", "/home/YOUR_USERNAME/bin/UnityMCP/UnityMcpServer/src", "server.py" ] } // ... other servers might be here ... } }

(YOUR_USERNAMEを置き換えてください)


使用方法 ▶️

  1. Unityプロジェクトを開いてください。Unity MCP Bridge(パッケージ)は自動的に接続されます。「ウィンドウ」>「Unity MCP」でステータスを確認してください。
  2. MCPクライアント(Claude、Cursorなど)を起動します。インストール手順3の設定を使用して、Unity MCPサーバー(Python)が自動的に起動します。
  3. Interact! Unity ツールが MCP クライアントで利用できるようになります。例のプロンプト: Create a 3D player controller.

貢献中🤝

Unity MCP の改善にご協力ください。

  1. メインリポジトリをフォークします
  2. ブランチを作成します( feature/your-ideaまたはbugfix/your-fix )。
  3. 変更を加えます。
  4. コミット(特徴: クールな新機能の追加)。
  5. ブランチをプッシュします
  6. マスター ブランチに対してプル リクエストを開きます

トラブルシューティング ❓

  • Unity Bridge が実行/接続されていない:
    • Unity エディターが開いていることを確認します。
    • ステータス ウィンドウを確認します: ウィンドウ > Unity MCP。
    • Unity を再起動します。
  • MCP クライアントが接続されない / サーバーが起動しない:
    • サーバーパスの確認: MCPクライアントのJSON設定ファイル内の--directoryパスを再確認してください。インストール手順1でUnityMCPリポジトリをクローンした場所(例:.../Programs/UnityMCP/UnityMcpServer/src)と完全に一致している必要があります。
    • uv を確認する: uv がインストールされ、動作していることを確認します (pip show uv)。
    • **手動で実行:**ターミナルから直接サーバーを実行してエラーを確認してください: # Navigate to the src directory first! cd /path/to/your/UnityMCP/UnityMcpServer/src uv run server.py
    • **権限(macOS/Linux):**サーバーを/usr/local/binなどのシステムの場所にインストールした場合、MCPクライアントを実行するユーザーにuvの実行とそこにあるファイルへのアクセス権限があることを確認してください。~/binにインストールする方が簡単かもしれません。
  • 自動構成に失敗しました:
    • 手動設定手順を使用してください。自動設定では、MCPクライアントの設定ファイルへの書き込み権限がない可能性があります。

まだ問題が解決しない場合は、 問題を開いてください


ライセンス📜

MIT ライセンス。LICENSEファイルを参照してください。


お問い合わせ👋


謝辞🙏

貢献者と Unity チームに感謝します。

ID: nvp2xgx3x1