クイックスタート
June 8, 2026 · View on GitHub
Unity MCP 用のクロスプラットフォームCLIツール — プロジェクトの作成、プラグインのインストール、MCPツールの設定、MCP接続を有効にしたUnityの起動まで、すべてを単一のコマンドラインから実行できます。
- :white_check_mark: プロジェクト作成 — Unity Editorを使用して新しいUnityプロジェクトをスキャフォールド
- :white_check_mark: エディターのインストール — コマンドラインから任意のバージョンのUnity Editorをインストール
- :white_check_mark: プラグインのインストール — 必要なスコープレジストリとともにUnity-MCPプラグインを
manifest.jsonに追加 - :white_check_mark: プラグインの削除 — Unity-MCPプラグインを
manifest.jsonから削除 - :white_check_mark: 設定 — MCPツール、プロンプト、リソースの有効化/無効化
- :white_check_mark: ステータス確認 — Unityプロセス、ローカルサーバー、クラウドサーバーの接続状態を一目で確認
- :white_check_mark: ツールの実行 — コマンドラインからMCPツールを直接実行
- :white_check_mark: MCPのセットアップ — 14種類のサポート対象エージェントのAIエージェントMCP設定ファイルを書き出し
- :white_check_mark: スキルのセットアップ — MCPサーバー経由でAIエージェント用のスキルファイルを生成
- :white_check_mark: 準備完了待機 — Unity EditorとMCPサーバーが接続されてツール呼び出しを受け付けるまでポーリング
- :white_check_mark: 起動と接続 — MCP環境変数を設定してUnityを起動し、自動的にサーバーに接続
- :white_check_mark: クロスプラットフォーム — Windows、macOS、Linuxに対応
- :white_check_mark: CI対応 — 非インタラクティブターミナルを自動検出し、スピナーやカラーを無効化
- :white_check_mark: 詳細モード — 任意のコマンドで
--verboseを使用して詳細な診断出力を取得 - :white_check_mark: バージョン管理 — プラグインのバージョンをダウングレードせず、OpenUPMから最新版を解決
クイックスタート
グローバルにインストールして実行します:
# 1.1 Install unity-mcp-cli # ┌────────────────────┐
npm install -g unity-mcp-cli # │ Available AI agent │
# ├────────────────────┤
# 1.2 (Optional) Install Unity # │ antigravity │
unity-mcp-cli install-unity # │ claude-code │
# │ claude-desktop │
# 1.3 (Optional) Create Unity project # │ cline │
unity-mcp-cli create-project ./MyUnityProject # │ codex │
# │ cursor │
# 2. Install "AI Game Developer" in Unity project # │ gemini │
unity-mcp-cli install-plugin ./MyUnityProject # │ github-copilot-cli │
# │ kilo-code │
# 3. Login to cloud server # │ open-code │
unity-mcp-cli login ./MyUnityProject # │ rider-junie │
# │ unity-ai │
# 4. Open Unity project (auto-connects and generates skills) │ vs-copilot │
unity-mcp-cli open ./MyUnityProject # │ vscode-copilot │
# └────────────────────┘
# 5. Wait for Unity Editor to be ready
unity-mcp-cli wait-for-ready ./MyUnityProject
またはnpxで任意のコマンドを即座に実行できます — グローバルインストールは不要です:
npx unity-mcp-cli install-plugin /path/to/unity/project
必要要件: Node.js ^20.19.0 || >=22.12.0。Unity Hubは見つからない場合、自動的にインストールされます。
目次
コマンド
configure
UserSettings/AI-Game-Developer-Config.jsonでMCPツール、プロンプト、リソースを設定します。
unity-mcp-cli configure ./MyGame --list
| オプション | 必須 | 説明 |
|---|---|---|
[path] | はい | Unityプロジェクトへのパス(位置引数または--path) |
--list | いいえ | 現在の設定を表示して終了 |
--enable-tools <names> | いいえ | 特定のツールを有効化(カンマ区切り) |
--disable-tools <names> | いいえ | 特定のツールを無効化(カンマ区切り) |
--enable-all-tools | いいえ | すべてのツールを有効化 |
--disable-all-tools | いいえ | すべてのツールを無効化 |
--enable-prompts <names> | いいえ | 特定のプロンプトを有効化(カンマ区切り) |
--disable-prompts <names> | いいえ | 特定のプロンプトを無効化(カンマ区切り) |
--enable-all-prompts | いいえ | すべてのプロンプトを有効化 |
--disable-all-prompts | いいえ | すべてのプロンプトを無効化 |
--enable-resources <names> | いいえ | 特定のリソースを有効化(カンマ区切り) |
--disable-resources <names> | いいえ | 特定のリソースを無効化(カンマ区切り) |
--enable-all-resources | いいえ | すべてのリソースを有効化 |
--disable-all-resources | いいえ | すべてのリソースを無効化 |
例 — 特定のツールを有効化し、すべてのプロンプトを無効化:
unity-mcp-cli configure ./MyGame \
--enable-tools gameobject-create,gameobject-find \
--disable-all-prompts
例 — すべてを有効化:
unity-mcp-cli configure ./MyGame \
--enable-all-tools \
--enable-all-prompts \
--enable-all-resources
create-project
Unity Editorを使用して新しいUnityプロジェクトを作成します。
unity-mcp-cli create-project /path/to/new/project
| オプション | 必須 | 説明 |
|---|---|---|
[path] | はい | プロジェクトを作成するパス(位置引数または--path) |
--unity <version> | いいえ | 使用するUnity Editorのバージョン(デフォルトはインストール済みの最新版) |
例 — 特定のエディターバージョンでプロジェクトを作成:
unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
install-plugin
UnityプロジェクトのPackages/manifest.jsonにUnity-MCPプラグインをインストールします。
unity-mcp-cli install-plugin ./MyGame
| オプション | 必須 | 説明 |
|---|---|---|
[path] | はい | Unityプロジェクトへのパス(位置引数または--path) |
--plugin-version <version> | いいえ | インストールするプラグインのバージョン(デフォルトはOpenUPMの最新版) |
このコマンドは以下を実行します:
- 必要なすべてのスコープを含むOpenUPMスコープレジストリを追加
com.ivanmurzak.unity.mcpをdependenciesに追加- ダウングレードしない — より高いバージョンが既にインストールされている場合、それが維持されます
例 — 特定のプラグインバージョンをインストール:
unity-mcp-cli install-plugin ./MyGame --plugin-version 0.51.6
このコマンドを実行した後、パッケージのインストールを完了するためにUnity Editorでプロジェクトを開いてください。
install-unity
Unity Hub CLI経由でUnity Editorのバージョンをインストールします。
unity-mcp-cli install-unity 6000.3.1f1
| 引数/オプション | 必須 | 説明 |
|---|---|---|
[version] | いいえ | インストールするUnity Editorのバージョン(例:6000.3.1f1) |
--path <path> | いいえ | 既存のプロジェクトから必要なバージョンを読み取る |
引数もオプションも指定されない場合、Unity Hubのリリース一覧から最新の安定版をインストールします。
例 — プロジェクトが必要とするエディターバージョンをインストール:
unity-mcp-cli install-unity --path ./MyGame
open
Unity EditorでUnityプロジェクトを開きます。デフォルトでは、接続オプションが指定されている場合にMCP接続環境変数を設定します。MCP接続なしで開くには--no-connectを使用してください。
unity-mcp-cli open ./MyGame
| オプション | 環境変数 | 必須 | 説明 |
|---|---|---|---|
[path] | — | はい | Unityプロジェクトへのパス(位置引数または--path) |
--unity <version> | — | いいえ | 使用する特定のUnity Editorバージョン(デフォルトはプロジェクト設定のバージョン、なければインストール済みの最新版) |
--no-connect | — | いいえ | MCP接続環境変数なしで開く |
--url <url> | UNITY_MCP_HOST | いいえ | 接続先のMCPサーバーURL |
--keep-connected | UNITY_MCP_KEEP_CONNECTED | いいえ | 接続を維持し続ける |
--token <token> | UNITY_MCP_TOKEN | いいえ | 認証トークン |
--auth <option> | UNITY_MCP_AUTH_OPTION | いいえ | 認証モード:noneまたはrequired |
--tools <names> | UNITY_MCP_TOOLS | いいえ | 有効にするツールのカンマ区切りリスト |
--transport <method> | UNITY_MCP_TRANSPORT | いいえ | トランスポート方式:streamableHttpまたはstdio |
--start-server <value> | UNITY_MCP_START_SERVER | いいえ | MCPサーバーの自動起動を制御(trueまたはfalse) |
エディタープロセスはデタッチモードで起動されます — CLIは即座に制御を返します。
例 — MCP接続付きで開く:
unity-mcp-cli open ./MyGame \
--url http://localhost:8080 \
--keep-connected
例 — MCP接続なしで開く(シンプルな起動):
unity-mcp-cli open ./MyGame --no-connect
例 — 認証と特定のツールを指定して開く:
unity-mcp-cli open ./MyGame \
--url http://my-server:8080 \
--token my-secret-token \
--auth required \
--tools gameobject-create,gameobject-find
run-tool
HTTP API経由でMCPツールを直接実行します。サーバーURLと認証トークンは、現在の接続モード(カスタムまたはクラウド)に基づいて、プロジェクトの設定ファイル(UserSettings/AI-Game-Developer-Config.json)から自動的に解決されます。
unity-mcp-cli run-tool gameobject-create ./MyGame --input '{"name":"Cube"}'
| オプション | 必須 | 説明 |
|---|---|---|
<tool-name> | はい | 実行するMCPツールの名前 |
[path] | いいえ | Unityプロジェクトのパス(位置引数または--path)— 設定の読み取りとポートの検出に使用 |
--url <url> | いいえ | サーバーURLの直接指定(設定をバイパス) |
--token <token> | いいえ | Bearerトークンの直接指定(設定をバイパス) |
--input <json> | いいえ | ツール引数のJSON文字列(デフォルトは{}) |
--input-file <file> | いいえ | ファイルからJSON引数を読み取り |
--raw | いいえ | 生のJSONを出力(フォーマットなし、スピナーなし) |
--timeout <ms> | いいえ | リクエストタイムアウト(ミリ秒単位、デフォルト:60000) |
URL解決の優先順位:
--url→ 直接使用- 設定ファイル →
host(カスタムモード)またはハードコードされたクラウドエンドポイント(クラウドモード) - プロジェクトパスからの決定論的ポート
認証はプロジェクト設定から自動的に読み取られます(カスタムモードではtoken、クラウドモードではcloudToken)。--tokenを使用すると、設定から取得されたトークンを明示的にオーバーライドできます。
例 — ツールを呼び出す(URLと認証は設定から取得):
unity-mcp-cli run-tool gameobject-find ./MyGame --input '{"query":"Player"}'
例 — URLを明示的にオーバーライド:
unity-mcp-cli run-tool scene-save --url http://localhost:8080
例 — 生のJSON出力をパイプ:
unity-mcp-cli run-tool assets-list ./MyGame --raw | jq '.results'
wait-for-ready
Unity EditorとMCPサーバーが接続され、ツール呼び出しを受け付ける準備ができるまで待機します。設定可能な間隔でサーバーをポーリングし、正常に応答するかタイムアウトに達するまで待ちます。openでUnityを起動した後、エージェントがツールの呼び出しを開始できるタイミングを知る必要がある自動化スクリプトやAIエージェントのオーケストレーションに便利です。
unity-mcp-cli wait-for-ready ./MyGame
| オプション | 必須 | 説明 |
|---|---|---|
[path] | いいえ | Unityプロジェクトのパス(位置引数または--path)— 設定の読み取りとポートの検出に使用 |
--url <url> | いいえ | サーバーURLの直接指定(設定をバイパス) |
--token <token> | いいえ | Bearerトークンの直接指定(設定をバイパス) |
--timeout <ms> | いいえ | 最大待機時間(ミリ秒単位、デフォルト:120000) |
--interval <ms> | いいえ | ポーリング間隔(ミリ秒単位、デフォルト:3000) |
例 — デフォルトタイムアウト(120秒)で待機:
unity-mcp-cli open ./MyGame
unity-mcp-cli wait-for-ready ./MyGame
unity-mcp-cli run-tool tests-run ./MyGame --input '{"testMode":"EditMode"}'
例 — CI用の短いタイムアウト:
unity-mcp-cli wait-for-ready ./MyGame --timeout 60000 --interval 2000
例 — サーバーURLを明示的に指定:
unity-mcp-cli wait-for-ready --url http://localhost:8080 --timeout 30000
setup-mcp
AIエージェント用のMCP設定ファイルを書き出し、Unity Editor UIなしでヘッドレス/CIセットアップを可能にします。14種類すべてのエージェント(Claude Code、Cursor、Geminiなど)をサポートしています。
unity-mcp-cli setup-mcp claude-code ./MyGame
| オプション | 必須 | 説明 |
|---|---|---|
[agent-id] | はい | 設定するエージェント(--listで一覧を表示) |
[path] | いいえ | Unityプロジェクトのパス(デフォルトはカレントディレクトリ) |
--transport <transport> | いいえ | トランスポート方式:stdioまたはhttp(デフォルト:http) |
--url <url> | いいえ | サーバーURLのオーバーライド(httpトランスポート用) |
--token <token> | いいえ | 認証トークンのオーバーライド |
--list | いいえ | 利用可能なすべてのエージェントIDを一覧表示 |
例 — サポート対象の全エージェントを一覧表示:
unity-mcp-cli setup-mcp --list
例 — stdioトランスポートでCursorを設定:
unity-mcp-cli setup-mcp cursor ./MyGame --transport stdio
setup-skills
MCPサーバーのシステムツールAPIを呼び出して、AIエージェント用のスキルファイルを生成します。MCPプラグインがインストールされた状態でUnity Editorが実行中である必要があります。
unity-mcp-cli setup-skills claude-code ./MyGame
| オプション | 必須 | 説明 |
|---|---|---|
[agent-id] | はい | スキルを生成するエージェント(--listで一覧を表示) |
[path] | いいえ | Unityプロジェクトのパス(デフォルトはカレントディレクトリ) |
--url <url> | いいえ | サーバーURLのオーバーライド |
--token <token> | いいえ | 認証トークンのオーバーライド |
--list | いいえ | スキルサポート状況を含むすべてのエージェントを一覧表示 |
--timeout <ms> | いいえ | リクエストタイムアウト(ミリ秒単位、デフォルト:60000) |
例 — スキルサポート対応のエージェントを一覧表示:
unity-mcp-cli setup-skills --list
remove-plugin
UnityプロジェクトのPackages/manifest.jsonからUnity-MCPプラグインを削除します。
unity-mcp-cli remove-plugin ./MyGame
| オプション | 必須 | 説明 |
|---|---|---|
[path] | はい | Unityプロジェクトへのパス(位置引数または--path) |
このコマンドは以下を実行します:
dependenciesからcom.ivanmurzak.unity.mcpを削除- スコープレジストリとスコープを維持 — 他のパッケージが依存している可能性があるため
- プラグインがインストールされていない場合は何もしない
このコマンドを実行した後、変更を適用するためにUnity Editorでプロジェクトを開いてください。
status
Unity EditorとMCPサーバーの接続状態を確認します。Unityが実行中かどうか、ローカルMCPサーバーが到達可能かどうか、設定されたサーバー(例:クラウド)が到達可能かどうかを表示します。
unity-mcp-cli status ./MyGame
| オプション | 必須 | 説明 |
|---|---|---|
[path] | いいえ | Unityプロジェクトのパス(位置引数または--path) |
--url <url> | いいえ | サーバーURLの直接指定(設定をバイパス) |
--token <token> | いいえ | Bearerトークンの直接指定(設定をバイパス) |
--timeout <ms> | いいえ | プローブタイムアウト(ミリ秒単位、デフォルト:5000) |
グローバルオプション
以下のオプションはすべてのコマンドで使用できます:
| オプション | 説明 |
|---|---|
-v, --verbose | トラブルシューティング用の詳細な診断出力を有効化 |
--version | CLIバージョンを表示 |
--help | コマンドのヘルプを表示 |
例 — 詳細出力付きでコマンドを実行:
unity-mcp-cli install-plugin ./MyGame --verbose
完全自動化の例
1つのスクリプトで完全なUnity MCPプロジェクトをゼロからセットアップします:
# 1. Create a new Unity project
unity-mcp-cli create-project ./MyAIGame --unity 6000.3.1f1
# 2. Install the Unity-MCP plugin
unity-mcp-cli install-plugin ./MyAIGame
# 3. Enable all MCP tools
unity-mcp-cli configure ./MyAIGame --enable-all-tools
# 4. Login to cloud server (authenticates and saves token)
unity-mcp-cli login ./MyAIGame
# 5. Open the project (auto-connects and generates skills for claude-code)
unity-mcp-cli open ./MyAIGame
# 6. Wait for Unity Editor and MCP server to be ready
unity-mcp-cli wait-for-ready ./MyAIGame
# 7. Run tests to verify everything works
unity-mcp-cli run-tool tests-run ./MyAIGame --input '{"testMode":"EditMode"}'
仕組み
決定論的ポート
CLIは、ディレクトリパスに基づいて各Unityプロジェクトの決定論的ポートを生成します(SHA256ハッシュをポート範囲20000〜29999にマッピング)。これはUnityプラグインのポート生成と一致するため、手動設定なしでサーバーとプラグインが自動的に同じポートで通信できます。
プラグインのインストール
install-pluginコマンドはPackages/manifest.jsonを直接変更します:
- OpenUPMスコープレジストリ(
package.openupm.com)を追加 - 必要なすべてのスコープを登録(
com.ivanmurzak、extensions.unity) - バージョン管理付きで
com.ivanmurzak.unity.mcp依存関係を追加(ダウングレードしない)
設定ファイル
configureコマンドはUserSettings/AI-Game-Developer-Config.jsonを読み書きし、以下を制御します:
- ツール — AIエージェントが利用可能なMCPツール
- プロンプト — LLM会話に注入される事前定義プロンプト
- リソース — AIエージェントに公開される読み取り専用データ
- 接続設定 — ホストURL、認証トークン、トランスポート方式、タイムアウト
Unity Hub連携
エディターの管理やプロジェクトの作成を行うコマンドはUnity Hub CLI(--headlessモード)を使用します。Unity Hubがインストールされていない場合、CLIは自動的にダウンロードしてインストールします:
- Windows —
UnityHubSetup.exe /Sによるサイレントインストール(管理者権限が必要な場合があります) - macOS — DMGをダウンロードしてマウントし、
Unity Hub.appを/Applicationsにコピー - Linux —
UnityHub.AppImageを~/Applications/にダウンロード
Unity-MCPプロジェクトの完全なドキュメントについては、メインREADMEをご覧ください。