Skip to content

Commit 370a360

Browse files
committed
docs: update README with client-specific config flows and mcp_source.py documentation
1 parent 4e1b905 commit 370a360

File tree

2 files changed

+47
-3
lines changed

2 files changed

+47
-3
lines changed

README-DEV.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Deploys your development code to the actual installation locations for testing.
3636
3. Enter server path (or use default: `%LOCALAPPDATA%\Programs\UnityMCP\UnityMcpServer\src`)
3737
4. Enter backup location (or use default: `%USERPROFILE%\Desktop\unity-mcp-backup`)
3838

39+
**Note:** Dev deploy skips `.venv`, `__pycache__`, `.pytest_cache`, `.mypy_cache`, `.git`; reduces churn and avoids copying virtualenvs.
40+
3941
### `restore-dev.bat`
4042
Restores original files from backup.
4143

@@ -73,6 +75,23 @@ Note: In recent builds, the Python server sources are also bundled inside the pa
7375
5. **Restore** original files when done using `restore-dev.bat`
7476

7577

78+
## Switching MCP package sources quickly
79+
80+
Use `mcp_source.py` to quickly switch between different Unity MCP package sources:
81+
82+
**Usage:**
83+
```bash
84+
python mcp_source.py [--manifest /path/to/manifest.json] [--repo /path/to/unity-mcp] [--choice 1|2|3]
85+
```
86+
87+
**Options:**
88+
- **1** Upstream main (CoplayDev/unity-mcp)
89+
- **2** Remote current branch (origin + branch)
90+
- **3** Local workspace (file: UnityMcpBridge)
91+
92+
After switching, open Package Manager and Refresh to re-resolve packages.
93+
94+
7695
## Troubleshooting
7796

7897
### "Path not found" errors running the .bat file
@@ -88,4 +107,7 @@ Note: In recent builds, the Python server sources are also bundled inside the pa
88107
### "Backup not found" errors
89108
- Run `deploy-dev.bat` first to create initial backup
90109
- Check backup directory permissions
91-
- Verify backup directory path is correct
110+
- Verify backup directory path is correct
111+
112+
### Windows uv path issues
113+
- On Windows, when testing GUI clients, prefer the WinGet Links `uv.exe`; if multiple `uv.exe` exist, use "Choose UV Install Location" to pin the Links shim.

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,13 @@ Connect your MCP Client (Claude, Cursor, etc.) to the Python server you installe
124124
125125
1. In Unity, go to `Window > Unity MCP`.
126126
2. Click `Auto-Setup`.
127-
3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client\'s config file automatically)*.
127+
3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client\'s config file automatically).*
128+
129+
Client-specific notes
130+
131+
- **VSCode**: uses `Code/User/mcp.json` with top-level `servers.unityMCP` and `"type": "stdio"`. On Windows, Unity MCP writes an absolute `uv.exe` (prefers WinGet Links shim) to avoid PATH issues.
132+
- **Cursor / Windsurf**: if `uv` is missing, the Unity MCP window shows "uv Not Found" with a quick [HELP] link and a "Choose UV Install Location" button.
133+
- **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.
128134
129135
130136
**Option B: Manual Configuration**
@@ -137,7 +143,23 @@ If Auto-Setup fails or you use a different client:
137143
2. **Edit the file** to add/update the `mcpServers` section, using the *exact* paths from Step 1.
138144

139145
<details>
140-
<summary><strong>Click for OS-Specific JSON Configuration Snippets...</strong></summary>
146+
<summary><strong>Click for Client-Specific JSON Configuration Snippets...</strong></summary>
147+
148+
**VSCode (all OS)**
149+
150+
```json
151+
{
152+
"servers": {
153+
"unityMCP": {
154+
"command": "uv",
155+
"args": ["--directory","<ABSOLUTE_PATH_TO>/UnityMcpServer/src","run","server.py"],
156+
"type": "stdio"
157+
}
158+
}
159+
}
160+
```
161+
162+
On Windows, set `command` to the absolute shim, e.g. `C:\\Users\\YOU\\AppData\\Local\\Microsoft\\WinGet\\Links\\uv.exe`.
141163

142164
**Windows:**
143165

0 commit comments

Comments
 (0)