Skip to content

Commit c1507d8

Browse files
committed
Standardize casing of renamed project to "MCP for Unity", as it is on the asset store
1 parent 892e2e4 commit c1507d8

File tree

9 files changed

+48
-48
lines changed

9 files changed

+48
-48
lines changed

CursorHelp.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
### Cursor/VSCode/Windsurf: UV path issue on Windows (diagnosis and fix)
22

33
#### 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.
55

66
#### 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.
99

1010
#### Real-world example
1111
- Wrong/fragile path (auto-picked):
@@ -15,7 +15,7 @@
1515
- `C:\Users\mrken\AppData\Local\Microsoft\WinGet\Links\uv.exe`
1616

1717
#### Quick fix (recommended)
18-
1) In MCP For Unity: `Window > MCP For Unity` → select your MCP client (Cursor or Windsurf)
18+
1) In MCP for Unity: `Window > MCP for Unity` → select your MCP client (Cursor or Windsurf)
1919
2) If you see “uv Not Found,” click “Choose `uv` Install Location” and browse to:
2020
- `C:\Users\<YOU>\AppData\Local\Microsoft\WinGet\Links\uv.exe`
2121
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.
7272
Recommended practice
7373

7474
- 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.
7676
- 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.
7777

7878
References

README-DEV.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# MCP For Unity Development Tools
1+
# MCP for Unity Development Tools
22

3-
Welcome to the MCP For Unity development environment! This directory contains tools and utilities to streamline MCP For Unity core development.
3+
Welcome to the MCP for Unity development environment! This directory contains tools and utilities to streamline MCP for Unity core development.
44

55
## 🚀 Available Development Features
66

77
### ✅ Development Deployment Scripts
8-
Quick deployment and testing tools for MCP For Unity core changes.
8+
Quick deployment and testing tools for MCP for Unity core changes.
99

1010
### 🔄 Coming Soon
1111
- **Development Mode Toggle**: Built-in Unity editor development features
1212
- **Hot Reload System**: Real-time code updates without Unity restarts
13-
- **Plugin Development Kit**: Tools for creating custom MCP For Unity extensions
13+
- **Plugin Development Kit**: Tools for creating custom MCP for Unity extensions
1414
- **Automated Testing Suite**: Comprehensive testing framework for contributions
1515
- **Debug Dashboard**: Advanced debugging and monitoring tools
1616

1717
---
1818

1919
## Development Deployment Scripts
2020

21-
These deployment scripts help you quickly test changes to MCP For Unity core code.
21+
These deployment scripts help you quickly test changes to MCP for Unity core code.
2222

2323
## Scripts
2424

@@ -60,7 +60,7 @@ X:\UnityProject\Library\PackageCache\com.coplaydev.unity-mcp@272123cfd97e
6060

6161
To find it reliably:
6262
1. Open Unity Package Manager
63-
2. Select "MCP For Unity" package
63+
2. Select "MCP for Unity" package
6464
3. Right click the package and choose "Show in Explorer"
6565
4. That opens the exact cache folder Unity is using for your project
6666

@@ -77,7 +77,7 @@ Note: In recent builds, the Python server sources are also bundled inside the pa
7777

7878
## Switching MCP package sources quickly
7979

80-
Use `mcp_source.py` to quickly switch between different MCP For Unity package sources:
80+
Use `mcp_source.py` to quickly switch between different MCP for Unity package sources:
8181

8282
**Usage:**
8383
```bash
@@ -96,7 +96,7 @@ After switching, open Package Manager and Refresh to re-resolve packages.
9696

9797
### "Path not found" errors running the .bat file
9898
- Verify Unity package cache path is correct
99-
- Check that MCP For Unity package is actually installed
99+
- Check that MCP for Unity package is actually installed
100100
- Ensure server is installed via MCP client
101101

102102
### "Permission denied" errors

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MCP For Unity ✨
1+
# MCP for Unity ✨
22

33
#### 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)
44

@@ -13,13 +13,13 @@
1313

1414
**Create your Unity apps with LLMs!**
1515

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.
1717

1818
## 💬 Join Our Community
1919

2020
### [Discord](https://discord.gg/y4p8KfzrN4)
2121

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!**
2323

2424
---
2525

@@ -49,12 +49,12 @@ MCP For Unity acts as a bridge, allowing AI assistants (like Claude, Cursor) to
4949

5050
## How It Works 🤔
5151

52-
MCP For Unity connects your tools using two components:
52+
MCP for Unity connects your tools using two components:
5353

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).
5656

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)]`
5858

5959
---
6060

@@ -129,14 +129,14 @@ Connect your MCP Client (Claude, Cursor, etc.) to the Python server set up in St
129129
130130
**Option A: Auto-Setup (Recommended for Claude/Cursor/VSC Copilot)**
131131
132-
1. In Unity, go to `Window > MCP For Unity`.
132+
1. In Unity, go to `Window > MCP for Unity`.
133133
2. Click `Auto-Setup`.
134134
3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client\'s config file automatically).*
135135

136136
<details><summary><strong>Client-specific troubleshooting</strong></summary>
137137

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.
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.
140140
- **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>
141141
142142
@@ -252,9 +252,9 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
252252

253253
## Usage ▶️
254254

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.
256256

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.
258258

259259
3. **Interact!** Unity tools should now be available in your MCP Client.
260260

@@ -304,9 +304,9 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
304304

305305
### Development Tools
306306

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:
308308

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
310310
- **Automatic Backup System**: Safe testing with easy rollback capabilities
311311
- **Hot Reload Workflow**: Fast iteration cycle for core development
312312
- **More coming!**
@@ -315,7 +315,7 @@ If you\'re contributing to MCP For Unity or want to test core changes, we have d
315315

316316
### Contributing 🤝
317317

318-
Help make MCP For Unity better!
318+
Help make MCP for Unity better!
319319

320320
1. **Fork** the main repository.
321321

@@ -338,7 +338,7 @@ Help make MCP For Unity better!
338338

339339
- **Unity Bridge Not Running/Connecting:**
340340
- Ensure Unity Editor is open.
341-
- Check the status window: Window > MCP For Unity.
341+
- Check the status window: Window > MCP for Unity.
342342
- Restart Unity.
343343
- **MCP Client Not Connecting / Server Not Starting:**
344344
- **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).

UnityMcpBridge/Editor/Helpers/ServerInstaller.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public static void EnsureServerInstalled()
4949

5050
if (hasInstalled || TryGetEmbeddedServerSource(out _))
5151
{
52-
Debug.LogWarning($"MCP For Unity: Using existing server; skipped install. Details: {ex.Message}");
52+
Debug.LogWarning($"MCP for Unity: Using existing server; skipped install. Details: {ex.Message}");
5353
return;
5454
}
5555

UnityMcpBridge/Editor/Helpers/ServerPathResolver.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ private static bool TryResolveWithinPackage(UnityEditor.PackageManager.PackageIn
113113
if (warnOnLegacyPackageId && p.name == LegacyId)
114114
{
115115
Debug.LogWarning(
116-
"MCP For Unity: Detected legacy package id 'com.justinpbarnett.unity-mcp'. " +
116+
"MCP for Unity: Detected legacy package id 'com.justinpbarnett.unity-mcp'. " +
117117
"Please update Packages/manifest.json to 'com.coplaydev.unity-mcp' to avoid future breakage.");
118118
}
119119

UnityMcpBridge/Editor/Windows/UnityMcpEditorWindow.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1558,7 +1558,7 @@ private void CheckMcpConfiguration(McpClient mcpClient)
15581558
{
15591559
if (debugLogsEnabled)
15601560
{
1561-
UnityEngine.Debug.Log($"MCP For Unity: Auto-updated MCP config for '{mcpClient.name}' to new path: {pythonDir}");
1561+
UnityEngine.Debug.Log($"MCP for Unity: Auto-updated MCP config for '{mcpClient.name}' to new path: {pythonDir}");
15621562
}
15631563
mcpClient.SetStatus(McpStatus.Configured);
15641564
}
@@ -1572,7 +1572,7 @@ private void CheckMcpConfiguration(McpClient mcpClient)
15721572
mcpClient.SetStatus(McpStatus.IncorrectPath);
15731573
if (debugLogsEnabled)
15741574
{
1575-
UnityEngine.Debug.LogWarning($"MCP For Unity: Auto-config rewrite failed for '{mcpClient.name}': {ex.Message}");
1575+
UnityEngine.Debug.LogWarning($"MCP for Unity: Auto-config rewrite failed for '{mcpClient.name}': {ex.Message}");
15761576
}
15771577
}
15781578
}
@@ -1594,7 +1594,7 @@ private void RegisterWithClaudeCode(string pythonDir)
15941594
string claudePath = ExecPath.ResolveClaude();
15951595
if (string.IsNullOrEmpty(claudePath))
15961596
{
1597-
UnityEngine.Debug.LogError("MCP For Unity: Claude CLI not found. Set a path in this window or install the CLI, then try again.");
1597+
UnityEngine.Debug.LogError("MCP for Unity: Claude CLI not found. Set a path in this window or install the CLI, then try again.");
15981598
return;
15991599
}
16001600
string uvPath = ExecPath.ResolveUv() ?? "uv";
@@ -1627,7 +1627,7 @@ private void RegisterWithClaudeCode(string pythonDir)
16271627
}
16281628
else
16291629
{
1630-
UnityEngine.Debug.LogError($"MCP For Unity: Failed to start Claude CLI.\n{stderr}\n{stdout}");
1630+
UnityEngine.Debug.LogError($"MCP for Unity: Failed to start Claude CLI.\n{stderr}\n{stdout}");
16311631
}
16321632
return;
16331633
}
@@ -1644,7 +1644,7 @@ private void UnregisterWithClaudeCode()
16441644
string claudePath = ExecPath.ResolveClaude();
16451645
if (string.IsNullOrEmpty(claudePath))
16461646
{
1647-
UnityEngine.Debug.LogError("MCP For Unity: Claude CLI not found. Set a path in this window or install the CLI, then try again.");
1647+
UnityEngine.Debug.LogError("MCP for Unity: Claude CLI not found. Set a path in this window or install the CLI, then try again.");
16481648
return;
16491649
}
16501650

@@ -1672,7 +1672,7 @@ private void UnregisterWithClaudeCode()
16721672
if (claudeClient != null)
16731673
{
16741674
claudeClient.SetStatus(McpStatus.NotConfigured);
1675-
UnityEngine.Debug.Log("Claude CLI reports no MCP For Unity server via 'mcp get' - setting status to NotConfigured and aborting unregister.");
1675+
UnityEngine.Debug.Log("Claude CLI reports no MCP for Unity server via 'mcp get' - setting status to NotConfigured and aborting unregister.");
16761676
Repaint();
16771677
}
16781678
return;
@@ -1687,7 +1687,7 @@ private void UnregisterWithClaudeCode()
16871687
if (ExecPath.TryRun(claudePath, $"mcp remove {serverName}", projectDir, out var stdout, out var stderr, 10000, pathPrepend))
16881688
{
16891689
success = true;
1690-
UnityEngine.Debug.Log($"MCP For Unity: Successfully removed MCP server: {serverName}");
1690+
UnityEngine.Debug.Log($"MCP for Unity: Successfully removed MCP server: {serverName}");
16911691
break;
16921692
}
16931693
else if (!string.IsNullOrEmpty(stderr) &&
@@ -1709,7 +1709,7 @@ private void UnregisterWithClaudeCode()
17091709
CheckClaudeCodeConfiguration(claudeClient);
17101710
}
17111711
Repaint();
1712-
UnityEngine.Debug.Log("MCP For Unity: MCP server successfully unregistered from Claude Code.");
1712+
UnityEngine.Debug.Log("MCP for Unity: MCP server successfully unregistered from Claude Code.");
17131713
}
17141714
else
17151715
{

claude-chunk.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### macOS: Claude CLI fails to start (dyld ICU library not loaded)
22

33
- 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 …”
55
- Running `claude` in Terminal fails with missing `libicui18n.xx.dylib`.
66

77
- Cause
@@ -20,32 +20,32 @@
2020
nvm install --lts
2121
nvm use --lts
2222
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
2424
```
2525
- Use the native installer (puts claude in a stable path):
2626
```bash
2727
# macOS/Linux
2828
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
3030
```
3131

3232
- After fixing
33-
- In MCP For Unity (Claude Code), click “Choose Claude Location” and select the working `claude` binary, then Register again.
33+
- In MCP for Unity (Claude Code), click “Choose Claude Location” and select the working `claude` binary, then Register again.
3434

3535
- More details
36-
- See: Troubleshooting MCP For Unity and Claude Code
36+
- See: Troubleshooting MCP for Unity and Claude Code
3737

3838
---
3939

4040
### FAQ (Claude Code)
4141

4242
- 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 select the 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 select the absolute path (e.g., `/opt/homebrew/bin/claude` or `~/.nvm/versions/node/<ver>/bin/claude`).
4444

4545
- Q: I installed via NVM; where is `claude`?
4646
- A: Typically `~/.nvm/versions/node/<ver>/bin/claude`. Our UI also scans NVM versions and you can browse to it via “Choose Claude Location”.
4747

4848
- 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.
5050

5151

deploy-dev.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
setlocal enabledelayedexpansion
33

44
echo ===============================================
5-
echo MCP For Unity Development Deployment Script
5+
echo MCP for Unity Development Deployment Script
66
echo ===============================================
77
echo.
88

restore-dev.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
setlocal enabledelayedexpansion
33

44
echo ===============================================
5-
echo MCP For Unity Development Restore Script
5+
echo MCP for Unity Development Restore Script
66
echo ===============================================
77
echo.
88
echo Note: The Python server is bundled under UnityMcpBridge\UnityMcpServer~ in the package.

0 commit comments

Comments
 (0)