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
@@ -20,10 +21,8 @@ Unity MCP acts as a bridge, allowing AI assistants (like Claude, Cursor) to inte
20
21
21
22
**Get help, share ideas, and collaborate with other Unity MCP developers!**
22
23
23
-
24
24
---
25
25
26
-
27
26
## Key Features 🚀
28
27
29
28
***🗣️ Natural Language Control:** Instruct your LLM to perform Unity tasks.
@@ -65,7 +64,6 @@ Unity MCP connects your tools using two components:
65
64
66
65
### Prerequisites
67
66
68
-
69
67
***Git CLI:** For cloning the server code. [Download Git](https://git-scm.com/downloads)
70
68
***Python:** Version 3.12 or newer. [Download Python](https://www.python.org/downloads/)
71
69
***Unity Hub & Editor:** Version 2020.3 LTS or newer. [Download Unity](https://unity.com/download)
@@ -98,9 +96,8 @@ Unity MCP connects your tools using two components:
98
96
3. Ensure .NET compatibility settings are correct
99
97
4. Add `USE_ROSLYN` to Scripting Define Symbols
100
98
5. Restart Unity
101
-
102
-
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.</details>
103
99
100
+
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.</details>
104
101
105
102
### Step 1: Install the Unity Package (Bridge)
106
103
@@ -114,6 +111,8 @@ Unity MCP connects your tools using two components:
114
111
5. Click `Add`.
115
112
6. The MCP Server should automatically be installed onto your machine as a result of this process.
116
113
114
+
**Note:** If you installed the MCP Server before Coplay's maintenance, you will need to uninstall the old package before re-installing the new one.
115
+
117
116
### Step 2: Configure Your MCP Client
118
117
119
118
Connect your MCP Client (Claude, Cursor, etc.) to the Python server you installed in Step 1.
@@ -177,6 +176,7 @@ If Auto-Configure fails or you use a different client:
177
176
}
178
177
}
179
178
```
179
+
180
180
(Replace YOUR_USERNAME if using ~/bin)
181
181
182
182
**Linux:**
@@ -200,18 +200,18 @@ If Auto-Configure fails or you use a different client:
200
200
201
201
(Replace YOUR_USERNAME)
202
202
203
-
204
-
205
203
**For Claude Code**
206
204
207
205
If you\'re using Claude Code, you can register the MCP server using these commands:
208
206
209
207
**macOS:**
208
+
210
209
```bash
211
210
claude mcp add UnityMCP -- uv --directory /[PATH_TO]/UnityMCP/UnityMcpServer/src run server.py
212
211
```
213
212
214
213
**Windows:**
214
+
215
215
```bash
216
216
claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/Scripts/uv.exe" --directory "C:/Users/USERNAME/AppData/Local/Programs/UnityMCP/UnityMcpServer/src" run server.py
217
217
```
@@ -228,23 +228,26 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
228
228
3. **Interact!** Unity tools should now be available in your MCP Client.
229
229
230
230
Example Prompt: `Create a 3D player controller`, `Create a yellow and bridge sun`, `Create a cool shader and apply it on a cube`.
231
-
231
+
232
232
---
233
233
234
234
## Future Dev Plans (Besides PR) 📝
235
235
236
236
### 🔴 High Priority
237
+
237
238
- [ ] **Asset Generation Improvements** - Enhanced server request handling and asset pipeline optimization
<summary><strong>Click to view common issues and fixes...</strong></summary>
303
307
304
308
- **Unity Bridge Not Running/Connecting:**
305
-
306
309
- Ensure Unity Editor is open.
307
-
308
310
- Check the status window: Window > Unity MCP.
309
-
310
311
- Restart Unity.
311
-
312
312
- **MCP Client Not Connecting / Server Not Starting:**
313
-
314
313
- **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).
315
-
316
314
- **Verify uv:** Make sure `uv` is installed and working (pip show uv).
317
-
318
315
- **Run Manually:** Try running the server directly from the terminal to see errors: `# Navigate to the src directory first! cd /path/to/your/UnityMCP/UnityMcpServer/src uv run server.py`
319
-
320
316
- **Permissions (macOS/Linux):** If you installed the server in a system location like /usr/local/bin, ensure the user running the MCP client has permission to execute uv and access files there. Installing in~/bin might be easier.
321
-
322
317
- **Auto-Configure Failed:**
323
-
324
318
- Use the Manual Configuration steps. Auto-configure might lack permissions to write to the MCP client\'s config file.
325
319
326
-
327
320
</details>
328
321
329
322
Still stuck? [Open an Issue](https://github.com/CoplayDev/unity-mcp/issues) or [Join the Discord](https://discord.gg/y4p8KfzrN4)!
@@ -336,19 +329,14 @@ MIT License. See [LICENSE](LICENSE) file.
336
329
337
330
---
338
331
339
-
## Acknowledgments 🙏
340
-
341
-
Thanks to the contributors and our sponsors [Coplay](https://coplay.dev/?ref=unity-mcp).
342
-
343
332
## Star History
344
333
345
334
[](https://www.star-history.com/#CoplayDev/unity-mcp&Date)
0 commit comments