Skip to content

Commit 9ce66cd

Browse files
author
ichimi abunai
committed
docs: add remote MCP bridge connection documentation
Add documentation for UNITY_HOST environment variable and Unity Editor remote connection settings to all language READMEs.
1 parent 9386c71 commit 9ce66cd

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed

README-ja.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,18 @@ MCP Unityサーバーを起動するには2つの方法があります:
255255
> [!TIP]
256256
> AIコーディングIDE(Claude Desktop、Cursor IDE、Windsurf IDEなど)とMCPサーバー間のタイムアウトは、使用するIDEによって異なる場合があります。
257257
258+
## オプション:リモート MCP ブリッジ接続を許可する
259+
260+
デフォルトでは、WebSocket サーバーは 'localhost' にバインドされています。他のマシンから MCP ブリッジ接続を許可するには、以下の手順に従ってください:
261+
262+
1. Unity エディターを開く
263+
2. メニューから「Tools > MCP Unity > Server Window」を選択
264+
3. 「Allow Remote Connections(リモート接続を許可)」チェックボックスを有効にする
265+
4. Unity は WebSocket サーバーを '0.0.0.0'(すべてのインターフェース)にバインドします
266+
5. Node.js サーバーを再起動して新しいホスト設定を適用する
267+
6. リモートで MCP ブリッジを実行する場合は、環境変数 UNITY_HOST を Unity 実行マシンの IP アドレスに設定して起動:
268+
`UNITY_HOST=192.168.1.100 node server.js`
269+
258270
## サポート & フィードバック
259271

260272
ご質問やサポートが必要な場合は、このリポジトリの[Issue](https://github.com/CoderGamester/mcp-unity/issues)を開くか、以下までご連絡ください:

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,17 @@ You can change depending on the OS you are using:
245245
> [!TIP]
246246
> The timeout between your AI Coding IDE (e.g., Claude Desktop, Cursor IDE, Windsurf IDE) and the MCP Server depends on the IDE.
247247
248+
## Optional: Allow Remote MCP Bridge Connections
249+
250+
By default, the WebSocket server binds to 'localhost'. To allow MCP bridge connections from other machines:
251+
252+
1. Open the Unity Editor
253+
2. Navigate to Tools > MCP Unity > Server Window
254+
3. Enable the "Allow Remote Connections" checkbox
255+
4. Unity will bind the WebSocket server to '0.0.0.0' (all interfaces)
256+
5. Restart the Node.js server to apply the new host configuration
257+
6. Set the environment variable UNITY_HOST to your Unity machine's IP address when running the MCP bridge remotely: `UNITY_HOST=192.168.1.100 node server.js`
258+
248259
## <a name="debug-server"></a>Debugging the Server
249260

250261
<details>

README_zh-CN.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,18 @@ MCP Unity 通过将 Unity `Library/PackedCache` 文件夹添加到您的工作
244244
> [!TIP]
245245
> 您的 AI 编码 IDE(例如 Claude Desktop、Cursor IDE、Windsurf IDE)与 MCP 服务器之间的超时时间取决于 IDE。
246246
247+
## 可选:允许远程 MCP Bridge 连接
248+
249+
默认情况下,WebSocket 服务器绑定到 'localhost'。要允许来自其他设备的 MCP Bridge 连接,请执行以下步骤:
250+
251+
1. 打开 Unity 编辑器
252+
2. 依次点击菜单「Tools > MCP Unity > Server Window」
253+
3. 勾选"Allow Remote Connections(允许远程连接)"复选框
254+
4. Unity 将 WebSocket 服务器绑定到 '0.0.0.0'(所有网络接口)
255+
5. 重新启动 Node.js 服务器以应用新的主机配置
256+
6. 在远程运行 MCP Bridge 时,将环境变量 UNITY_HOST 设置为 Unity 所在机器的 IP 地址:
257+
`UNITY_HOST=192.168.1.100 node server.js`
258+
247259
## <a name="debug-server"></a>调试服务器
248260

249261
<details>

0 commit comments

Comments
 (0)