unity-mcp-cli 0.57.1 → 0.57.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -20
- package/docs/README.es.md +155 -135
- package/docs/README.ja.md +184 -164
- package/docs/README.zh-CN.md +133 -113
- package/package.json +1 -1
package/docs/README.ja.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<div align="center" width="100%">
|
|
2
2
|
<h1>Unity MCP — <i>CLI</i></h1>
|
|
3
3
|
|
|
4
|
-
[](https://www.npmjs.com/package/unity-mcp-cli)
|
|
5
5
|
[](https://nodejs.org/)
|
|
6
6
|
[](https://github.com/IvanMurzak/Unity-MCP/blob/main/LICENSE)
|
|
7
7
|
[](https://stand-with-ukraine.pp.ua)
|
|
@@ -25,52 +25,69 @@
|
|
|
25
25
|
|
|
26
26
|
</div>
|
|
27
27
|
|
|
28
|
-
<b>[
|
|
28
|
+
<b>[中文](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.zh-CN.md) | [日本語](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.ja.md) | [Español](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.es.md)</b>
|
|
29
29
|
|
|
30
|
-
**[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)**
|
|
30
|
+
**[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)** 用のクロスプラットフォームCLIツール — プロジェクトの作成、プラグインのインストール、MCPツールの設定、MCP接続を有効にしたUnityの起動まで、すべてを単一のコマンドラインから実行できます。
|
|
31
31
|
|
|
32
|
-
## 
|
|
32
|
+
## 
|
|
33
33
|
|
|
34
|
-
- :white_check_mark:
|
|
35
|
-
- :white_check_mark: **エディターのインストール** —
|
|
36
|
-
- :white_check_mark: **プラグインのインストール** —
|
|
37
|
-
- :white_check_mark: **プラグインの削除** — Unity-MCP
|
|
38
|
-
- :white_check_mark: **設定** — MCP
|
|
39
|
-
- :white_check_mark: **ツールの実行** — MCP
|
|
40
|
-
- :white_check_mark: **MCP
|
|
41
|
-
- :white_check_mark: **スキルのセットアップ** — MCP
|
|
42
|
-
- :white_check_mark:
|
|
43
|
-
- :white_check_mark: **クロスプラットフォーム** — Windows、macOS、Linux
|
|
44
|
-
- :white_check_mark: **CI
|
|
45
|
-
- :white_check_mark: **詳細モード** —
|
|
46
|
-
- :white_check_mark:
|
|
34
|
+
- :white_check_mark: **プロジェクト作成** — Unity Editorを使用して新しいUnityプロジェクトをスキャフォールド
|
|
35
|
+
- :white_check_mark: **エディターのインストール** — コマンドラインから任意のバージョンのUnity Editorをインストール
|
|
36
|
+
- :white_check_mark: **プラグインのインストール** — 必要なスコープレジストリとともにUnity-MCPプラグインを`manifest.json`に追加
|
|
37
|
+
- :white_check_mark: **プラグインの削除** — Unity-MCPプラグインを`manifest.json`から削除
|
|
38
|
+
- :white_check_mark: **設定** — MCPツール、プロンプト、リソースの有効化/無効化
|
|
39
|
+
- :white_check_mark: **ツールの実行** — コマンドラインからMCPツールを直接実行
|
|
40
|
+
- :white_check_mark: **MCPのセットアップ** — 14種類のサポート対象エージェントのAIエージェントMCP設定ファイルを書き出し
|
|
41
|
+
- :white_check_mark: **スキルのセットアップ** — MCPサーバー経由でAIエージェント用のスキルファイルを生成
|
|
42
|
+
- :white_check_mark: **起動と接続** — MCP環境変数を設定してUnityを起動し、自動的にサーバーに接続
|
|
43
|
+
- :white_check_mark: **クロスプラットフォーム** — Windows、macOS、Linuxに対応
|
|
44
|
+
- :white_check_mark: **CI対応** — 非インタラクティブターミナルを自動検出し、スピナーやカラーを無効化
|
|
45
|
+
- :white_check_mark: **詳細モード** — 任意のコマンドで`--verbose`を使用して詳細な診断出力を取得
|
|
46
|
+
- :white_check_mark: **バージョン管理** — プラグインのバージョンをダウングレードせず、OpenUPMから最新版を解決
|
|
47
47
|
|
|
48
|
-

|
|
48
|
+

|
|
49
49
|
|
|
50
50
|
# クイックスタート
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
グローバルにインストールして実行します:
|
|
53
53
|
|
|
54
54
|
```bash
|
|
55
|
-
|
|
56
|
-
unity-mcp-cli
|
|
55
|
+
# 1.1 Install unity-mcp-cli # ┌────────────────────┐
|
|
56
|
+
npm install -g unity-mcp-cli # │ Available AI agent │
|
|
57
|
+
# ├────────────────────┤
|
|
58
|
+
# 1.2 (Optional) Install Unity # │ antigravity │
|
|
59
|
+
unity-mcp-cli install-unity # │ claude-code │
|
|
60
|
+
# │ claude-desktop │
|
|
61
|
+
# 1.3 (Optional) Create Unity project # │ cline │
|
|
62
|
+
unity-mcp-cli create-project ./MyUnityProject # │ codex │
|
|
63
|
+
# │ cursor │
|
|
64
|
+
# 2. Install "AI Game Developer" in Unity project # │ gemini │
|
|
65
|
+
unity-mcp-cli install-plugin ./MyUnityProject # │ github-copilot-cli │
|
|
66
|
+
# │ kilo-code │
|
|
67
|
+
# 3. Setup Skills for Claude Code # │ open-code │
|
|
68
|
+
unity-mcp-cli setup-skills claude-code ./MyUnityProject # │ rider-junie │
|
|
69
|
+
# │ unity-ai │
|
|
70
|
+
# (Optional) Setup MCP for Claude Code # │ vs-copilot │
|
|
71
|
+
unity-mcp-cli setup-mcp claude-code ./MyUnityProject # │ vscode-copilot │
|
|
72
|
+
# └────────────────────┘
|
|
73
|
+
# (It depends...) Open Unity project
|
|
74
|
+
unity-mcp-cli open ./MyUnityProject
|
|
57
75
|
```
|
|
58
76
|
|
|
59
|
-
|
|
77
|
+
または`npx`で任意のコマンドを即座に実行できます — グローバルインストールは不要です:
|
|
60
78
|
|
|
61
79
|
```bash
|
|
62
80
|
npx unity-mcp-cli install-plugin /path/to/unity/project
|
|
63
81
|
```
|
|
64
82
|
|
|
65
|
-
>
|
|
83
|
+
> **必要要件:** [Node.js](https://nodejs.org/) ^20.19.0 || >=22.12.0。[Unity Hub](https://unity.com/download)は見つからない場合、自動的にインストールされます。
|
|
66
84
|
|
|
67
|
-

|
|
85
|
+

|
|
68
86
|
|
|
69
87
|
# 目次
|
|
70
88
|
|
|
71
|
-
- [クイックスタート](
|
|
72
|
-
- [
|
|
73
|
-
- [コマンド](#コマンド)
|
|
89
|
+
- [クイックスタート](#quick-start)
|
|
90
|
+
- [コマンド](#commands)
|
|
74
91
|
- [`configure`](#configure)
|
|
75
92
|
- [`create-project`](#create-project)
|
|
76
93
|
- [`install-plugin`](#install-plugin)
|
|
@@ -80,21 +97,21 @@ npx unity-mcp-cli install-plugin /path/to/unity/project
|
|
|
80
97
|
- [`setup-mcp`](#setup-mcp)
|
|
81
98
|
- [`setup-skills`](#setup-skills)
|
|
82
99
|
- [`remove-plugin`](#remove-plugin)
|
|
83
|
-
- [グローバルオプション](
|
|
84
|
-
- [完全自動化の例](
|
|
85
|
-
- [仕組み](
|
|
86
|
-
- [決定論的ポート](
|
|
87
|
-
- [
|
|
88
|
-
- [設定ファイル](
|
|
89
|
-
- [Unity Hub
|
|
100
|
+
- [グローバルオプション](#global-options)
|
|
101
|
+
- [完全自動化の例](#full-automation-example)
|
|
102
|
+
- [仕組み](#how-it-works)
|
|
103
|
+
- [決定論的ポート](#deterministic-port)
|
|
104
|
+
- [プラグインのインストール](#plugin-installation)
|
|
105
|
+
- [設定ファイル](#configuration-file)
|
|
106
|
+
- [Unity Hub連携](#unity-hub-integration)
|
|
90
107
|
|
|
91
|
-

|
|
108
|
+

|
|
92
109
|
|
|
93
110
|
# コマンド
|
|
94
111
|
|
|
95
112
|
## `configure`
|
|
96
113
|
|
|
97
|
-
`UserSettings/AI-Game-Developer-Config.json
|
|
114
|
+
`UserSettings/AI-Game-Developer-Config.json`でMCPツール、プロンプト、リソースを設定します。
|
|
98
115
|
|
|
99
116
|
```bash
|
|
100
117
|
unity-mcp-cli configure ./MyGame --list
|
|
@@ -102,22 +119,22 @@ unity-mcp-cli configure ./MyGame --list
|
|
|
102
119
|
|
|
103
120
|
| オプション | 必須 | 説明 |
|
|
104
121
|
|---|---|---|
|
|
105
|
-
| `[path]` | はい | Unity
|
|
106
|
-
| `--list` | いいえ |
|
|
107
|
-
| `--enable-tools <names>` | いいえ |
|
|
108
|
-
| `--disable-tools <names>` | いいえ |
|
|
109
|
-
| `--enable-all-tools` | いいえ |
|
|
110
|
-
| `--disable-all-tools` | いいえ |
|
|
111
|
-
| `--enable-prompts <names>` | いいえ |
|
|
112
|
-
| `--disable-prompts <names>` | いいえ |
|
|
113
|
-
| `--enable-all-prompts` | いいえ |
|
|
114
|
-
| `--disable-all-prompts` | いいえ |
|
|
115
|
-
| `--enable-resources <names>` | いいえ |
|
|
116
|
-
| `--disable-resources <names>` | いいえ |
|
|
117
|
-
| `--enable-all-resources` | いいえ |
|
|
118
|
-
| `--disable-all-resources` | いいえ |
|
|
119
|
-
|
|
120
|
-
**例 —
|
|
122
|
+
| `[path]` | はい | Unityプロジェクトへのパス(位置引数または`--path`) |
|
|
123
|
+
| `--list` | いいえ | 現在の設定を表示して終了 |
|
|
124
|
+
| `--enable-tools <names>` | いいえ | 特定のツールを有効化(カンマ区切り) |
|
|
125
|
+
| `--disable-tools <names>` | いいえ | 特定のツールを無効化(カンマ区切り) |
|
|
126
|
+
| `--enable-all-tools` | いいえ | すべてのツールを有効化 |
|
|
127
|
+
| `--disable-all-tools` | いいえ | すべてのツールを無効化 |
|
|
128
|
+
| `--enable-prompts <names>` | いいえ | 特定のプロンプトを有効化(カンマ区切り) |
|
|
129
|
+
| `--disable-prompts <names>` | いいえ | 特定のプロンプトを無効化(カンマ区切り) |
|
|
130
|
+
| `--enable-all-prompts` | いいえ | すべてのプロンプトを有効化 |
|
|
131
|
+
| `--disable-all-prompts` | いいえ | すべてのプロンプトを無効化 |
|
|
132
|
+
| `--enable-resources <names>` | いいえ | 特定のリソースを有効化(カンマ区切り) |
|
|
133
|
+
| `--disable-resources <names>` | いいえ | 特定のリソースを無効化(カンマ区切り) |
|
|
134
|
+
| `--enable-all-resources` | いいえ | すべてのリソースを有効化 |
|
|
135
|
+
| `--disable-all-resources` | いいえ | すべてのリソースを無効化 |
|
|
136
|
+
|
|
137
|
+
**例 — 特定のツールを有効化し、すべてのプロンプトを無効化:**
|
|
121
138
|
|
|
122
139
|
```bash
|
|
123
140
|
unity-mcp-cli configure ./MyGame \
|
|
@@ -125,7 +142,7 @@ unity-mcp-cli configure ./MyGame \
|
|
|
125
142
|
--disable-all-prompts
|
|
126
143
|
```
|
|
127
144
|
|
|
128
|
-
**例 —
|
|
145
|
+
**例 — すべてを有効化:**
|
|
129
146
|
|
|
130
147
|
```bash
|
|
131
148
|
unity-mcp-cli configure ./MyGame \
|
|
@@ -134,11 +151,11 @@ unity-mcp-cli configure ./MyGame \
|
|
|
134
151
|
--enable-all-resources
|
|
135
152
|
```
|
|
136
153
|
|
|
137
|
-

|
|
154
|
+

|
|
138
155
|
|
|
139
156
|
## `create-project`
|
|
140
157
|
|
|
141
|
-
Unity Editor
|
|
158
|
+
Unity Editorを使用して新しいUnityプロジェクトを作成します。
|
|
142
159
|
|
|
143
160
|
```bash
|
|
144
161
|
unity-mcp-cli create-project /path/to/new/project
|
|
@@ -146,20 +163,20 @@ unity-mcp-cli create-project /path/to/new/project
|
|
|
146
163
|
|
|
147
164
|
| オプション | 必須 | 説明 |
|
|
148
165
|
|---|---|---|
|
|
149
|
-
| `[path]` | はい |
|
|
150
|
-
| `--unity <version>` | いいえ | 使用する
|
|
166
|
+
| `[path]` | はい | プロジェクトを作成するパス(位置引数または`--path`) |
|
|
167
|
+
| `--unity <version>` | いいえ | 使用するUnity Editorのバージョン(デフォルトはインストール済みの最新版) |
|
|
151
168
|
|
|
152
|
-
**例 —
|
|
169
|
+
**例 — 特定のエディターバージョンでプロジェクトを作成:**
|
|
153
170
|
|
|
154
171
|
```bash
|
|
155
172
|
unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
|
|
156
173
|
```
|
|
157
174
|
|
|
158
|
-

|
|
175
|
+

|
|
159
176
|
|
|
160
177
|
## `install-plugin`
|
|
161
178
|
|
|
162
|
-
Unity
|
|
179
|
+
Unityプロジェクトの`Packages/manifest.json`にUnity-MCPプラグインをインストールします。
|
|
163
180
|
|
|
164
181
|
```bash
|
|
165
182
|
unity-mcp-cli install-plugin ./MyGame
|
|
@@ -167,50 +184,50 @@ unity-mcp-cli install-plugin ./MyGame
|
|
|
167
184
|
|
|
168
185
|
| オプション | 必須 | 説明 |
|
|
169
186
|
|---|---|---|
|
|
170
|
-
| `[path]` | はい | Unity
|
|
171
|
-
| `--plugin-version <version>` | いいえ |
|
|
187
|
+
| `[path]` | はい | Unityプロジェクトへのパス(位置引数または`--path`) |
|
|
188
|
+
| `--plugin-version <version>` | いいえ | インストールするプラグインのバージョン(デフォルトは[OpenUPM](https://openupm.com/packages/com.ivanmurzak.unity.mcp/)の最新版) |
|
|
172
189
|
|
|
173
|
-
|
|
174
|
-
1.
|
|
175
|
-
2. `com.ivanmurzak.unity.mcp
|
|
176
|
-
3. **ダウングレードしない** —
|
|
190
|
+
このコマンドは以下を実行します:
|
|
191
|
+
1. 必要なすべてのスコープを含む**OpenUPMスコープレジストリ**を追加
|
|
192
|
+
2. `com.ivanmurzak.unity.mcp`を`dependencies`に追加
|
|
193
|
+
3. **ダウングレードしない** — より高いバージョンが既にインストールされている場合、それが維持されます
|
|
177
194
|
|
|
178
|
-
**例 —
|
|
195
|
+
**例 — 特定のプラグインバージョンをインストール:**
|
|
179
196
|
|
|
180
197
|
```bash
|
|
181
198
|
unity-mcp-cli install-plugin ./MyGame --plugin-version 0.51.6
|
|
182
199
|
```
|
|
183
200
|
|
|
184
|
-
>
|
|
201
|
+
> このコマンドを実行した後、パッケージのインストールを完了するためにUnity Editorでプロジェクトを開いてください。
|
|
185
202
|
|
|
186
|
-

|
|
203
|
+

|
|
187
204
|
|
|
188
205
|
## `install-unity`
|
|
189
206
|
|
|
190
|
-
Unity Hub CLI
|
|
207
|
+
Unity Hub CLI経由でUnity Editorのバージョンをインストールします。
|
|
191
208
|
|
|
192
209
|
```bash
|
|
193
210
|
unity-mcp-cli install-unity 6000.3.1f1
|
|
194
211
|
```
|
|
195
212
|
|
|
196
|
-
|
|
|
213
|
+
| 引数/オプション | 必須 | 説明 |
|
|
197
214
|
|---|---|---|
|
|
198
|
-
| `[version]` | いいえ | インストールする
|
|
215
|
+
| `[version]` | いいえ | インストールするUnity Editorのバージョン(例:`6000.3.1f1`) |
|
|
199
216
|
| `--path <path>` | いいえ | 既存のプロジェクトから必要なバージョンを読み取る |
|
|
200
217
|
|
|
201
|
-
|
|
218
|
+
引数もオプションも指定されない場合、Unity Hubのリリース一覧から最新の安定版をインストールします。
|
|
202
219
|
|
|
203
|
-
**例 —
|
|
220
|
+
**例 — プロジェクトが必要とするエディターバージョンをインストール:**
|
|
204
221
|
|
|
205
222
|
```bash
|
|
206
223
|
unity-mcp-cli install-unity --path ./MyGame
|
|
207
224
|
```
|
|
208
225
|
|
|
209
|
-

|
|
226
|
+

|
|
210
227
|
|
|
211
228
|
## `open`
|
|
212
229
|
|
|
213
|
-
Unity
|
|
230
|
+
Unity EditorでUnityプロジェクトを開きます。デフォルトでは、接続オプションが指定されている場合にMCP接続環境変数を設定します。MCP接続なしで開くには`--no-connect`を使用してください。
|
|
214
231
|
|
|
215
232
|
```bash
|
|
216
233
|
unity-mcp-cli open ./MyGame
|
|
@@ -218,20 +235,20 @@ unity-mcp-cli open ./MyGame
|
|
|
218
235
|
|
|
219
236
|
| オプション | 環境変数 | 必須 | 説明 |
|
|
220
237
|
|---|---|---|---|
|
|
221
|
-
| `[path]` | — | はい | Unity
|
|
222
|
-
| `--unity <version>` | — | いいえ |
|
|
223
|
-
| `--no-connect` | — | いいえ | MCP
|
|
224
|
-
| `--url <url>` | `UNITY_MCP_HOST` | いいえ | 接続先の
|
|
225
|
-
| `--keep-connected` | `UNITY_MCP_KEEP_CONNECTED` | いいえ |
|
|
238
|
+
| `[path]` | — | はい | Unityプロジェクトへのパス(位置引数または`--path`) |
|
|
239
|
+
| `--unity <version>` | — | いいえ | 使用する特定のUnity Editorバージョン(デフォルトはプロジェクト設定のバージョン、なければインストール済みの最新版) |
|
|
240
|
+
| `--no-connect` | — | いいえ | MCP接続環境変数なしで開く |
|
|
241
|
+
| `--url <url>` | `UNITY_MCP_HOST` | いいえ | 接続先のMCPサーバーURL |
|
|
242
|
+
| `--keep-connected` | `UNITY_MCP_KEEP_CONNECTED` | いいえ | 接続を維持し続ける |
|
|
226
243
|
| `--token <token>` | `UNITY_MCP_TOKEN` | いいえ | 認証トークン |
|
|
227
|
-
| `--auth <option>` | `UNITY_MCP_AUTH_OPTION` | いいえ |
|
|
244
|
+
| `--auth <option>` | `UNITY_MCP_AUTH_OPTION` | いいえ | 認証モード:`none`または`required` |
|
|
228
245
|
| `--tools <names>` | `UNITY_MCP_TOOLS` | いいえ | 有効にするツールのカンマ区切りリスト |
|
|
229
|
-
| `--transport <method>` | `UNITY_MCP_TRANSPORT` | いいえ |
|
|
230
|
-
| `--start-server <value>` | `UNITY_MCP_START_SERVER` | いいえ |
|
|
246
|
+
| `--transport <method>` | `UNITY_MCP_TRANSPORT` | いいえ | トランスポート方式:`streamableHttp`または`stdio` |
|
|
247
|
+
| `--start-server <value>` | `UNITY_MCP_START_SERVER` | いいえ | MCPサーバーの自動起動を制御(`true`または`false`) |
|
|
231
248
|
|
|
232
|
-
|
|
249
|
+
エディタープロセスはデタッチモードで起動されます — CLIは即座に制御を返します。
|
|
233
250
|
|
|
234
|
-
**例 — MCP
|
|
251
|
+
**例 — MCP接続付きで開く:**
|
|
235
252
|
|
|
236
253
|
```bash
|
|
237
254
|
unity-mcp-cli open ./MyGame \
|
|
@@ -239,13 +256,13 @@ unity-mcp-cli open ./MyGame \
|
|
|
239
256
|
--keep-connected
|
|
240
257
|
```
|
|
241
258
|
|
|
242
|
-
**例 — MCP
|
|
259
|
+
**例 — MCP接続なしで開く(シンプルな起動):**
|
|
243
260
|
|
|
244
261
|
```bash
|
|
245
262
|
unity-mcp-cli open ./MyGame --no-connect
|
|
246
263
|
```
|
|
247
264
|
|
|
248
|
-
**例 —
|
|
265
|
+
**例 — 認証と特定のツールを指定して開く:**
|
|
249
266
|
|
|
250
267
|
```bash
|
|
251
268
|
unity-mcp-cli open ./MyGame \
|
|
@@ -255,11 +272,11 @@ unity-mcp-cli open ./MyGame \
|
|
|
255
272
|
--tools gameobject-create,gameobject-find
|
|
256
273
|
```
|
|
257
274
|
|
|
258
|
-

|
|
275
|
+

|
|
259
276
|
|
|
260
277
|
## `run-tool`
|
|
261
278
|
|
|
262
|
-
HTTP API
|
|
279
|
+
HTTP API経由でMCPツールを直接実行します。サーバーURLと認証トークンは、現在の接続モード(カスタムまたはクラウド)に基づいて、プロジェクトの設定ファイル(`UserSettings/AI-Game-Developer-Config.json`)から**自動的に解決**されます。
|
|
263
280
|
|
|
264
281
|
```bash
|
|
265
282
|
unity-mcp-cli run-tool gameobject-create ./MyGame --input '{"name":"Cube"}'
|
|
@@ -267,45 +284,45 @@ unity-mcp-cli run-tool gameobject-create ./MyGame --input '{"name":"Cube"}'
|
|
|
267
284
|
|
|
268
285
|
| オプション | 必須 | 説明 |
|
|
269
286
|
|---|---|---|
|
|
270
|
-
| `<tool-name>` | はい | 実行する
|
|
271
|
-
| `[path]` | いいえ | Unity
|
|
272
|
-
| `--url <url>` | いいえ | サーバー
|
|
273
|
-
| `--token <token>` | いいえ | Bearer
|
|
274
|
-
| `--input <json>` | いいえ | ツール引数の
|
|
275
|
-
| `--input-file <file>` | いいえ | ファイルから
|
|
276
|
-
| `--raw` | いいえ | 生の
|
|
277
|
-
| `--timeout <ms>` | いいえ |
|
|
278
|
-
|
|
279
|
-
**URL
|
|
287
|
+
| `<tool-name>` | はい | 実行するMCPツールの名前 |
|
|
288
|
+
| `[path]` | いいえ | Unityプロジェクトのパス(位置引数または`--path`)— 設定の読み取りとポートの検出に使用 |
|
|
289
|
+
| `--url <url>` | いいえ | サーバーURLの直接指定(設定をバイパス) |
|
|
290
|
+
| `--token <token>` | いいえ | Bearerトークンの直接指定(設定をバイパス) |
|
|
291
|
+
| `--input <json>` | いいえ | ツール引数のJSON文字列(デフォルトは`{}`) |
|
|
292
|
+
| `--input-file <file>` | いいえ | ファイルからJSON引数を読み取り |
|
|
293
|
+
| `--raw` | いいえ | 生のJSONを出力(フォーマットなし、スピナーなし) |
|
|
294
|
+
| `--timeout <ms>` | いいえ | リクエストタイムアウト(ミリ秒単位、デフォルト:60000) |
|
|
295
|
+
|
|
296
|
+
**URL解決の優先順位:**
|
|
280
297
|
1. `--url` → 直接使用
|
|
281
|
-
2. 設定ファイル → `host
|
|
298
|
+
2. 設定ファイル → `host`(カスタムモード)またはハードコードされたクラウドエンドポイント(クラウドモード)
|
|
282
299
|
3. プロジェクトパスからの決定論的ポート
|
|
283
300
|
|
|
284
|
-
|
|
301
|
+
**認証**はプロジェクト設定から自動的に読み取られます(カスタムモードでは`token`、クラウドモードでは`cloudToken`)。`--token`を使用すると、設定から取得されたトークンを明示的にオーバーライドできます。
|
|
285
302
|
|
|
286
|
-
**例 — ツールを呼び出す(URL
|
|
303
|
+
**例 — ツールを呼び出す(URLと認証は設定から取得):**
|
|
287
304
|
|
|
288
305
|
```bash
|
|
289
306
|
unity-mcp-cli run-tool gameobject-find ./MyGame --input '{"query":"Player"}'
|
|
290
307
|
```
|
|
291
308
|
|
|
292
|
-
**例 — URL
|
|
309
|
+
**例 — URLを明示的にオーバーライド:**
|
|
293
310
|
|
|
294
311
|
```bash
|
|
295
312
|
unity-mcp-cli run-tool scene-save --url http://localhost:8080
|
|
296
313
|
```
|
|
297
314
|
|
|
298
|
-
**例 — 生の
|
|
315
|
+
**例 — 生のJSON出力をパイプ:**
|
|
299
316
|
|
|
300
317
|
```bash
|
|
301
318
|
unity-mcp-cli run-tool assets-list ./MyGame --raw | jq '.results'
|
|
302
319
|
```
|
|
303
320
|
|
|
304
|
-

|
|
321
|
+

|
|
305
322
|
|
|
306
323
|
## `setup-mcp`
|
|
307
324
|
|
|
308
|
-
AI
|
|
325
|
+
AIエージェント用のMCP設定ファイルを書き出し、Unity Editor UIなしでヘッドレス/CIセットアップを可能にします。14種類すべてのエージェント(Claude Code、Cursor、Geminiなど)をサポートしています。
|
|
309
326
|
|
|
310
327
|
```bash
|
|
311
328
|
unity-mcp-cli setup-mcp claude-code ./MyGame
|
|
@@ -313,30 +330,30 @@ unity-mcp-cli setup-mcp claude-code ./MyGame
|
|
|
313
330
|
|
|
314
331
|
| オプション | 必須 | 説明 |
|
|
315
332
|
|---|---|---|
|
|
316
|
-
| `[agent-id]` | はい | 設定するエージェント(`--list
|
|
317
|
-
| `[path]` | いいえ | Unity
|
|
318
|
-
| `--transport <transport>` | いいえ |
|
|
319
|
-
| `--url <url>` | いいえ | サーバー
|
|
320
|
-
| `--token <token>` | いいえ |
|
|
321
|
-
| `--list` | いいえ | 利用可能なすべてのエージェント
|
|
333
|
+
| `[agent-id]` | はい | 設定するエージェント(`--list`で一覧を表示) |
|
|
334
|
+
| `[path]` | いいえ | Unityプロジェクトのパス(デフォルトはカレントディレクトリ) |
|
|
335
|
+
| `--transport <transport>` | いいえ | トランスポート方式:`stdio`または`http`(デフォルト:`http`) |
|
|
336
|
+
| `--url <url>` | いいえ | サーバーURLのオーバーライド(httpトランスポート用) |
|
|
337
|
+
| `--token <token>` | いいえ | 認証トークンのオーバーライド |
|
|
338
|
+
| `--list` | いいえ | 利用可能なすべてのエージェントIDを一覧表示 |
|
|
322
339
|
|
|
323
|
-
**例 —
|
|
340
|
+
**例 — サポート対象の全エージェントを一覧表示:**
|
|
324
341
|
|
|
325
342
|
```bash
|
|
326
343
|
unity-mcp-cli setup-mcp --list
|
|
327
344
|
```
|
|
328
345
|
|
|
329
|
-
**例 — Cursor
|
|
346
|
+
**例 — stdioトランスポートでCursorを設定:**
|
|
330
347
|
|
|
331
348
|
```bash
|
|
332
349
|
unity-mcp-cli setup-mcp cursor ./MyGame --transport stdio
|
|
333
350
|
```
|
|
334
351
|
|
|
335
|
-

|
|
352
|
+

|
|
336
353
|
|
|
337
354
|
## `setup-skills`
|
|
338
355
|
|
|
339
|
-
MCP
|
|
356
|
+
MCPサーバーのシステムツールAPIを呼び出して、AIエージェント用のスキルファイルを生成します。MCPプラグインがインストールされた状態でUnity Editorが実行中である必要があります。
|
|
340
357
|
|
|
341
358
|
```bash
|
|
342
359
|
unity-mcp-cli setup-skills claude-code ./MyGame
|
|
@@ -344,24 +361,24 @@ unity-mcp-cli setup-skills claude-code ./MyGame
|
|
|
344
361
|
|
|
345
362
|
| オプション | 必須 | 説明 |
|
|
346
363
|
|---|---|---|
|
|
347
|
-
| `[agent-id]` | はい | スキルを生成するエージェント(`--list
|
|
348
|
-
| `[path]` | いいえ | Unity
|
|
349
|
-
| `--url <url>` | いいえ | サーバー
|
|
350
|
-
| `--token <token>` | いいえ |
|
|
351
|
-
| `--list` | いいえ |
|
|
352
|
-
| `--timeout <ms>` | いいえ |
|
|
364
|
+
| `[agent-id]` | はい | スキルを生成するエージェント(`--list`で一覧を表示) |
|
|
365
|
+
| `[path]` | いいえ | Unityプロジェクトのパス(デフォルトはカレントディレクトリ) |
|
|
366
|
+
| `--url <url>` | いいえ | サーバーURLのオーバーライド |
|
|
367
|
+
| `--token <token>` | いいえ | 認証トークンのオーバーライド |
|
|
368
|
+
| `--list` | いいえ | スキルサポート状況を含むすべてのエージェントを一覧表示 |
|
|
369
|
+
| `--timeout <ms>` | いいえ | リクエストタイムアウト(ミリ秒単位、デフォルト:60000) |
|
|
353
370
|
|
|
354
|
-
**例 —
|
|
371
|
+
**例 — スキルサポート対応のエージェントを一覧表示:**
|
|
355
372
|
|
|
356
373
|
```bash
|
|
357
374
|
unity-mcp-cli setup-skills --list
|
|
358
375
|
```
|
|
359
376
|
|
|
360
|
-

|
|
377
|
+

|
|
361
378
|
|
|
362
379
|
## `remove-plugin`
|
|
363
380
|
|
|
364
|
-
Unity
|
|
381
|
+
Unityプロジェクトの`Packages/manifest.json`からUnity-MCPプラグインを削除します。
|
|
365
382
|
|
|
366
383
|
```bash
|
|
367
384
|
unity-mcp-cli remove-plugin ./MyGame
|
|
@@ -369,88 +386,91 @@ unity-mcp-cli remove-plugin ./MyGame
|
|
|
369
386
|
|
|
370
387
|
| オプション | 必須 | 説明 |
|
|
371
388
|
|---|---|---|
|
|
372
|
-
| `[path]` | はい | Unity
|
|
389
|
+
| `[path]` | はい | Unityプロジェクトへのパス(位置引数または`--path`) |
|
|
373
390
|
|
|
374
|
-
|
|
375
|
-
1. `com.ivanmurzak.unity.mcp
|
|
376
|
-
2.
|
|
377
|
-
3.
|
|
391
|
+
このコマンドは以下を実行します:
|
|
392
|
+
1. `dependencies`から`com.ivanmurzak.unity.mcp`を削除
|
|
393
|
+
2. **スコープレジストリとスコープを維持** — 他のパッケージが依存している可能性があるため
|
|
394
|
+
3. プラグインがインストールされていない場合は**何もしない**
|
|
378
395
|
|
|
379
|
-
>
|
|
396
|
+
> このコマンドを実行した後、変更を適用するためにUnity Editorでプロジェクトを開いてください。
|
|
380
397
|
|
|
381
|
-

|
|
398
|
+

|
|
382
399
|
|
|
383
400
|
## グローバルオプション
|
|
384
401
|
|
|
385
|
-
|
|
402
|
+
以下のオプションはすべてのコマンドで使用できます:
|
|
386
403
|
|
|
387
404
|
| オプション | 説明 |
|
|
388
405
|
|---|---|
|
|
389
|
-
| `-v, --verbose` |
|
|
390
|
-
| `--version` | CLI
|
|
391
|
-
| `--help` |
|
|
406
|
+
| `-v, --verbose` | トラブルシューティング用の詳細な診断出力を有効化 |
|
|
407
|
+
| `--version` | CLIバージョンを表示 |
|
|
408
|
+
| `--help` | コマンドのヘルプを表示 |
|
|
392
409
|
|
|
393
|
-
**例 —
|
|
410
|
+
**例 — 詳細出力付きでコマンドを実行:**
|
|
394
411
|
|
|
395
412
|
```bash
|
|
396
413
|
unity-mcp-cli install-plugin ./MyGame --verbose
|
|
397
414
|
```
|
|
398
415
|
|
|
399
|
-

|
|
416
|
+

|
|
400
417
|
|
|
401
418
|
# 完全自動化の例
|
|
402
419
|
|
|
403
|
-
1
|
|
420
|
+
1つのスクリプトで完全なUnity MCPプロジェクトをゼロからセットアップします:
|
|
404
421
|
|
|
405
422
|
```bash
|
|
406
|
-
# 1.
|
|
423
|
+
# 1. Create a new Unity project
|
|
407
424
|
unity-mcp-cli create-project ./MyAIGame --unity 6000.3.1f1
|
|
408
425
|
|
|
409
|
-
# 2. Unity-MCP
|
|
426
|
+
# 2. Install the Unity-MCP plugin
|
|
410
427
|
unity-mcp-cli install-plugin ./MyAIGame
|
|
411
428
|
|
|
412
|
-
# 3.
|
|
429
|
+
# 3. Enable all MCP tools
|
|
413
430
|
unity-mcp-cli configure ./MyAIGame --enable-all-tools
|
|
414
431
|
|
|
415
|
-
# 4. Claude Code
|
|
432
|
+
# 4. Setup Skills for Claude Code (requires Unity Editor running)
|
|
433
|
+
unity-mcp-cli setup-skills claude-code ./MyAIGame
|
|
434
|
+
|
|
435
|
+
# 5. Configure Claude Code MCP integration
|
|
416
436
|
unity-mcp-cli setup-mcp claude-code ./MyAIGame
|
|
417
437
|
|
|
418
|
-
#
|
|
438
|
+
# 6. Open the project with MCP connection
|
|
419
439
|
unity-mcp-cli open ./MyAIGame \
|
|
420
440
|
--url http://localhost:8080 \
|
|
421
441
|
--keep-connected
|
|
422
442
|
```
|
|
423
443
|
|
|
424
|
-

|
|
444
|
+

|
|
425
445
|
|
|
426
446
|
# 仕組み
|
|
427
447
|
|
|
428
448
|
### 決定論的ポート
|
|
429
449
|
|
|
430
|
-
CLI
|
|
450
|
+
CLIは、ディレクトリパスに基づいて各Unityプロジェクトの**決定論的ポート**を生成します(SHA256ハッシュをポート範囲20000〜29999にマッピング)。これはUnityプラグインのポート生成と一致するため、手動設定なしでサーバーとプラグインが自動的に同じポートで通信できます。
|
|
431
451
|
|
|
432
|
-
###
|
|
452
|
+
### プラグインのインストール
|
|
433
453
|
|
|
434
|
-
`install-plugin
|
|
435
|
-
- [OpenUPM](https://openupm.com/)
|
|
436
|
-
-
|
|
437
|
-
-
|
|
454
|
+
`install-plugin`コマンドは`Packages/manifest.json`を直接変更します:
|
|
455
|
+
- [OpenUPM](https://openupm.com/)スコープレジストリ(`package.openupm.com`)を追加
|
|
456
|
+
- 必要なすべてのスコープを登録(`com.ivanmurzak`、`extensions.unity`、`org.nuget.*`)
|
|
457
|
+
- バージョン管理付きで`com.ivanmurzak.unity.mcp`依存関係を追加(ダウングレードしない)
|
|
438
458
|
|
|
439
459
|
### 設定ファイル
|
|
440
460
|
|
|
441
|
-
`configure
|
|
442
|
-
-
|
|
443
|
-
-
|
|
444
|
-
-
|
|
445
|
-
- **接続設定** — ホスト
|
|
461
|
+
`configure`コマンドは`UserSettings/AI-Game-Developer-Config.json`を読み書きし、以下を制御します:
|
|
462
|
+
- **ツール** — AIエージェントが利用可能なMCPツール
|
|
463
|
+
- **プロンプト** — LLM会話に注入される事前定義プロンプト
|
|
464
|
+
- **リソース** — AIエージェントに公開される読み取り専用データ
|
|
465
|
+
- **接続設定** — ホストURL、認証トークン、トランスポート方式、タイムアウト
|
|
446
466
|
|
|
447
|
-
### Unity Hub
|
|
467
|
+
### Unity Hub連携
|
|
448
468
|
|
|
449
|
-
|
|
450
|
-
- **Windows** — `UnityHubSetup.exe /S
|
|
451
|
-
- **macOS** — DMG
|
|
452
|
-
- **Linux** — `UnityHub.AppImage
|
|
469
|
+
エディターの管理やプロジェクトの作成を行うコマンドは**Unity Hub CLI**(`--headless`モード)を使用します。Unity Hubがインストールされていない場合、CLIは**自動的にダウンロードしてインストール**します:
|
|
470
|
+
- **Windows** — `UnityHubSetup.exe /S`によるサイレントインストール(管理者権限が必要な場合があります)
|
|
471
|
+
- **macOS** — DMGをダウンロードしてマウントし、`Unity Hub.app`を`/Applications`にコピー
|
|
472
|
+
- **Linux** — `UnityHub.AppImage`を`~/Applications/`にダウンロード
|
|
453
473
|
|
|
454
|
-
> Unity-MCP
|
|
474
|
+
> Unity-MCPプロジェクトの完全なドキュメントについては、[メインREADME](https://github.com/IvanMurzak/Unity-MCP/blob/main/README.md)をご覧ください。
|
|
455
475
|
|
|
456
|
-

|
|
476
|
+

|