You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CursorHelp.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
### Cursor/VSCode/Windsurf: UV path issue on Windows (diagnosis and fix)
2
2
3
3
#### The issue
4
-
- Some Windows machines have multiple `uv.exe` locations. Our auto-config sometimes picked a less stable path, causing the MCP client to fail to launch the MCP For Unity Server or for the path to be auto-rewritten on repaint/restart.
4
+
- Some Windows machines have multiple `uv.exe` locations. Our auto-config sometimes picked a less stable path, causing the MCP client to fail to launch the MCP for Unity Server or for the path to be auto-rewritten on repaint/restart.
5
5
6
6
#### Typical symptoms
7
-
- Cursor shows the MCP For Unity server but never connects or reports it “can’t start.”
8
-
- Your `%USERPROFILE%\\.cursor\\mcp.json` flips back to a different `command` path when Unity or the MCP For Unity window refreshes.
7
+
- Cursor shows the MCP for Unity server but never connects or reports it “can’t start.”
8
+
- Your `%USERPROFILE%\\.cursor\\mcp.json` flips back to a different `command` path when Unity or the MCP for Unity window refreshes.
3) If uv is already found but wrong, still click “Choose `uv` Install Location” and select the `Links\uv.exe` path above. This saves a persistent override.
@@ -72,7 +72,7 @@ If that runs without error, restart Cursor and it should connect.
72
72
Recommended practice
73
73
74
74
- Prefer the WinGet Links shim paths above. If present, select one via “Choose `uv` Install Location”.
75
-
- If the unity window keeps rewriting to a different `uv.exe`, pick the Links shim again; MCP For Unity saves a pinned override and will stop auto-rewrites.
75
+
- If the unity window keeps rewriting to a different `uv.exe`, pick the Links shim again; MCP for Unity saves a pinned override and will stop auto-rewrites.
76
76
- If neither Links path exists, a reasonable fallback is `~/.local/bin/uv.exe` (uv tools bin) or a Scoop shim, but Links is preferred for stability.
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# MCP For Unity ✨
1
+
# MCP for Unity ✨
2
2
3
3
#### Proudly sponsored and maintained by [Coplay](https://www.coplay.dev/?ref=unity-mcp), the AI assistant for Unity. [Read the backstory here.](https://www.coplay.dev/blog/coplay-and-open-source-unity-mcp-join-forces)
4
4
@@ -13,13 +13,13 @@
13
13
14
14
**Create your Unity apps with LLMs!**
15
15
16
-
MCP For Unity acts as a bridge, allowing AI assistants (like Claude, Cursor) to interact directly with your Unity Editor via a local **MCP (Model Context Protocol) Client**. Give your LLM tools to manage assets, control scenes, edit scripts, and automate tasks within Unity.
16
+
MCP for Unity acts as a bridge, allowing AI assistants (like Claude, Cursor) to interact directly with your Unity Editor via a local **MCP (Model Context Protocol) Client**. Give your LLM tools to manage assets, control scenes, edit scripts, and automate tasks within Unity.
17
17
18
18
## 💬 Join Our Community
19
19
20
20
### [Discord](https://discord.gg/y4p8KfzrN4)
21
21
22
-
**Get help, share ideas, and collaborate with other MCP For Unity developers!**
22
+
**Get help, share ideas, and collaborate with other MCP for Unity developers!**
23
23
24
24
---
25
25
@@ -49,12 +49,12 @@ MCP For Unity acts as a bridge, allowing AI assistants (like Claude, Cursor) to
49
49
50
50
## How It Works 🤔
51
51
52
-
MCP For Unity connects your tools using two components:
52
+
MCP for Unity connects your tools using two components:
53
53
54
-
1.**MCP For Unity Bridge:** A Unity package running inside the Editor. (Installed via Package Manager).
55
-
2.**MCP For Unity Server:** A Python server that runs locally, communicating between the Unity Bridge and your MCP Client. (Installed automatically by the package on first run or via Auto-Setup; manual setup is available as a fallback).
54
+
1.**MCP for Unity Bridge:** A Unity package running inside the Editor. (Installed via Package Manager).
55
+
2.**MCP for Unity Server:** A Python server that runs locally, communicating between the Unity Bridge and your MCP Client. (Installed automatically by the package on first run or via Auto-Setup; manual setup is available as a fallback).
56
56
57
-
**Flow:**`[Your LLM via MCP Client] <-> [MCP For Unity Server (Python)] <-> [MCP For Unity Bridge (Unity Editor)]`
57
+
**Flow:**`[Your LLM via MCP Client] <-> [MCP for Unity Server (Python)] <-> [MCP for Unity Bridge (Unity Editor)]`
58
58
59
59
---
60
60
@@ -129,14 +129,14 @@ Connect your MCP Client (Claude, Cursor, etc.) to the Python server set up in St
129
129
130
130
**Option A: Auto-Setup (Recommended for Claude/Cursor/VSC Copilot)**
131
131
132
-
1. In Unity, go to `Window > MCP For Unity`.
132
+
1. In Unity, go to `Window > MCP for Unity`.
133
133
2. Click `Auto-Setup`.
134
134
3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client\'s config file automatically).*
- **VSCode**: uses `Code/User/mcp.json` with top-level `servers.unityMCP` and `"type": "stdio"`. On Windows, MCP For Unity writes an absolute `uv.exe` (prefers WinGet Links shim) to avoid PATH issues.
139
-
- **Cursor / Windsurf** [(**help link**)](https://github.com/CoplayDev/unity-mcp/wiki/1.-Fix-Unity-MCP-and-Cursor,-VSCode-&-Windsurf): if`uv` is missing, the MCP For Unity window shows "uv Not Found" with a quick [HELP] link and a "Choose `uv` Install Location" button.
138
+
- **VSCode**: uses `Code/User/mcp.json` with top-level `servers.unityMCP` and `"type": "stdio"`. On Windows, MCP for Unity writes an absolute `uv.exe` (prefers WinGet Links shim) to avoid PATH issues.
139
+
- **Cursor / Windsurf** [(**help link**)](https://github.com/CoplayDev/unity-mcp/wiki/1.-Fix-Unity-MCP-and-Cursor,-VSCode-&-Windsurf): if`uv` is missing, the MCP for Unity window shows "uv Not Found" with a quick [HELP] link and a "Choose `uv` Install Location" button.
140
140
- **Claude Code** [(**help link**)](https://github.com/CoplayDev/unity-mcp/wiki/2.-Fix-Unity-MCP-and-Claude-Code): if`claude` isn't found, the window shows "Claude Not Found" with [HELP] and a "Choose Claude Location" button. Unregister now updates the UI immediately.</details>
141
141
142
142
@@ -252,9 +252,9 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
252
252
253
253
## Usage ▶️
254
254
255
-
1. **Open your Unity Project.** The MCP For Unity package should connect automatically. Check status via Window > MCP For Unity.
255
+
1. **Open your Unity Project.** The MCP for Unity package should connect automatically. Check status via Window > MCP for Unity.
256
256
257
-
2. **Start your MCP Client** (Claude, Cursor, etc.). It should automatically launch the MCP For Unity Server (Python) using the configuration from Installation Step 2.
257
+
2. **Start your MCP Client** (Claude, Cursor, etc.). It should automatically launch the MCP for Unity Server (Python) using the configuration from Installation Step 2.
258
258
259
259
3. **Interact!** Unity tools should now be available in your MCP Client.
260
260
@@ -304,9 +304,9 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
304
304
305
305
### Development Tools
306
306
307
-
If you\'re contributing to MCP For Unity or want to test core changes, we have development tools to streamline your workflow:
307
+
If you\'re contributing to MCP for Unity or want to test core changes, we have development tools to streamline your workflow:
308
308
309
-
- **Development Deployment Scripts**: Quickly deploy and test your changes to MCP For Unity Bridge and Python Server
309
+
- **Development Deployment Scripts**: Quickly deploy and test your changes to MCP for Unity Bridge and Python Server
310
310
- **Automatic Backup System**: Safe testing with easy rollback capabilities
311
311
- **Hot Reload Workflow**: Fast iteration cycle for core development
312
312
- **More coming!**
@@ -315,7 +315,7 @@ If you\'re contributing to MCP For Unity or want to test core changes, we have d
315
315
316
316
### Contributing 🤝
317
317
318
-
Help make MCP For Unity better!
318
+
Help make MCP for Unity better!
319
319
320
320
1. **Fork** the main repository.
321
321
@@ -338,7 +338,7 @@ Help make MCP For Unity better!
338
338
339
339
- **Unity Bridge Not Running/Connecting:**
340
340
- Ensure Unity Editor is open.
341
-
- Check the status window: Window > MCP For Unity.
341
+
- Check the status window: Window > MCP for Unity.
342
342
- Restart Unity.
343
343
- **MCP Client Not Connecting / Server Not Starting:**
344
344
- **Verify Server Path:** Double-check the --directory path in your MCP Client\'s JSON config. It must exactly match the location where you cloned the UnityMCP repository in Installation Step 1 (e.g., .../Programs/UnityMCP/UnityMcpServer/src).
Copy file name to clipboardExpand all lines: claude-chunk.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
### macOS: Claude CLI fails to start (dyld ICU library not loaded)
2
2
3
3
- Symptoms
4
-
- MCP For Unity error: “Failed to start Claude CLI. dyld: Library not loaded: /usr/local/opt/icu4c/lib/libicui18n.71.dylib …”
4
+
- MCP for Unity error: “Failed to start Claude CLI. dyld: Library not loaded: /usr/local/opt/icu4c/lib/libicui18n.71.dylib …”
5
5
- Running `claude` in Terminal fails with missing `libicui18n.xx.dylib`.
6
6
7
7
- Cause
@@ -20,32 +20,32 @@
20
20
nvm install --lts
21
21
nvm use --lts
22
22
npm install -g @anthropic-ai/claude-code
23
-
# MCP For Unity → Claude Code → Choose Claude Location → ~/.nvm/versions/node/<ver>/bin/claude
23
+
# MCP for Unity → Claude Code → Choose Claude Location → ~/.nvm/versions/node/<ver>/bin/claude
24
24
```
25
25
- Use the native installer (puts claude in a stable path):
26
26
```bash
27
27
# macOS/Linux
28
28
curl -fsSL https://claude.ai/install.sh | bash
29
-
# MCP For Unity → Claude Code → Choose Claude Location → /opt/homebrew/bin/claude or ~/.local/bin/claude
29
+
# MCP for Unity → Claude Code → Choose Claude Location → /opt/homebrew/bin/claude or ~/.local/bin/claude
30
30
```
31
31
32
32
- After fixing
33
-
- In MCP For Unity (Claude Code), click “Choose Claude Location” and selectthe working `claude` binary, then Register again.
33
+
- In MCP for Unity (Claude Code), click “Choose Claude Location” and selectthe working `claude` binary, then Register again.
34
34
35
35
- More details
36
-
- See: Troubleshooting MCP For Unity and Claude Code
36
+
- See: Troubleshooting MCP for Unity and Claude Code
37
37
38
38
---
39
39
40
40
### FAQ (Claude Code)
41
41
42
42
- Q: Unity can’t find `claude` even though Terminal can.
43
-
- A: macOS apps launched from Finder/Hub don’t inherit your shell PATH. In the MCP For Unity window, click “Choose Claude Location” and selectthe absolute path (e.g., `/opt/homebrew/bin/claude` or `~/.nvm/versions/node/<ver>/bin/claude`).
43
+
- A: macOS apps launched from Finder/Hub don’t inherit your shell PATH. In the MCP for Unity window, click “Choose Claude Location” and selectthe absolute path (e.g., `/opt/homebrew/bin/claude` or `~/.nvm/versions/node/<ver>/bin/claude`).
44
44
45
45
- Q: I installed via NVM; where is `claude`?
46
46
- A: Typically `~/.nvm/versions/node/<ver>/bin/claude`. Our UI also scans NVM versions and you can browse to it via “Choose Claude Location”.
47
47
48
48
- Q: The Register button says “Claude Not Found”.
49
-
- A: Install the CLI or set the path. Click the orange “[HELP]” link in the MCP For Unity window for step‑by‑step install instructions, then choose the binary location.
49
+
- A: Install the CLI or set the path. Click the orange “[HELP]” link in the MCP for Unity window for step‑by‑step install instructions, then choose the binary location.
0 commit comments