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: README.md
+30-74Lines changed: 30 additions & 74 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
+
<imgwidth="676"height="380"alt="MCP for Unity"src="https://github.com/user-attachments/assets/b712e41d-273c-48b2-9041-82bd17ace267" />
2
2
3
3
#### Proudly sponsored and maintained by [Coplay](https://www.coplay.dev/?ref=unity-mcp) -- the best AI assistant for Unity. [Read the backstory here.](https://www.coplay.dev/blog/coplay-and-open-source-unity-mcp-join-forces)
4
4
@@ -15,9 +15,9 @@
15
15
16
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.
@@ -50,21 +50,19 @@ MCP for Unity acts as a bridge, allowing AI assistants (like Claude, Cursor) to
50
50
51
51
---
52
52
53
-
## How It Works 🤔
53
+
## How It Works
54
54
55
55
MCP for Unity connects your tools using two components:
56
56
57
57
1.**MCP for Unity Bridge:** A Unity package running inside the Editor. (Installed via Package Manager).
58
58
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).
59
59
60
-
**Flow:**`[Your LLM via MCP Client] <-> [MCP for Unity Server (Python)] <-> [MCP for Unity Bridge (Unity Editor)]`
* [Visual Studio Code Copilot](https://code.visualstudio.com/docs/copilot/overview)
82
-
* [Windsurf](https://windsurf.com)
83
-
**(Others may work with manual config)*
75
+
***An MCP Client:**: [Claude Desktop](https://claude.ai/download) | [Claude Code](https://github.com/anthropics/claude-code) | [Cursor](https://www.cursor.com/en/downloads) | [Visual Studio Code Copilot](https://code.visualstudio.com/docs/copilot/overview) | [Windsurf](https://windsurf.com) | Others work with manual config
76
+
84
77
*<details><summary><strong>[Optional] Roslyn for Advanced Script Validation</strong></summary>
85
78
86
79
For **Strict** validation level that catches undefined namespaces, types, and methods:
@@ -102,7 +95,8 @@ MCP for Unity connects your tools using two components:
102
95
103
96
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.</details>
104
97
105
-
### 🌟Step 1: Install the Unity Package🌟
98
+
---
99
+
### 🌟Install the Unity Package🌟
106
100
107
101
#### To install via Git URL
108
102
@@ -118,7 +112,7 @@ MCP for Unity connects your tools using two components:
118
112
119
113
#### To install via OpenUPM
120
114
121
-
1. Instal the [OpenUPM CLI](https://openupm.com/docs/getting-started-cli.html)
115
+
1. Install the [OpenUPM CLI](https://openupm.com/docs/getting-started-cli.html)
122
116
2. Open a terminal (PowerShell, Terminal, etc.) and navigate to your Unity project directory
123
117
3. Run `openupm add com.coplaydev.unity-mcp`
124
118
@@ -134,7 +128,7 @@ Connect your MCP Client (Claude, Cursor, etc.) to the Python server set up in St
134
128
135
129
1. In Unity, go to `Window > MCP for Unity`.
136
130
2. Click `Auto-Setup`.
137
-
3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client\'s config file automatically).*
131
+
3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client's config file automatically).*
- [x] **Shader Generation** - Generate shaders using CGProgram template
293
-
- [x] **Advanced Script Validation** - Multi-level validation with semantic analysis, namespace/type checking, and Unity best practices (Will need Roslyn Installed, see [Prerequisite](#prerequisites)).
294
-
</details>
262
+
## Development & Contributing 🛠️
295
263
296
-
### 🔬 Research & Exploration
264
+
### For Developers
297
265
298
-
- [ ] **AI-Powered Asset Generation** - Integration with AI tools for automatic 3D models, textures, and animations
299
-
- [ ] **Real-time Collaboration** - Live editing sessions between multiple developers *(Currently in progress)*
- [ ] **AR/VR Tool Integration** - Extended support for immersive development workflows
303
-
304
-
---
305
-
306
-
## For Developers 🛠️
307
-
308
-
### Development Tools
309
-
310
-
If you\'re contributing to MCP for Unity or want to test core changes, we have development tools to streamline your workflow:
266
+
If you're contributing to MCP for Unity or want to test core changes, we have development tools to streamline your workflow:
311
267
312
268
- **Development Deployment Scripts**: Quickly deploy and test your changes to MCP for Unity Bridge and Python Server
313
269
- **Automatic Backup System**: Safe testing with easy rollback capabilities
314
270
- **Hot Reload Workflow**: Fast iteration cycle for core development
315
-
- **More coming!**
316
271
317
272
📖 **See [README-DEV.md](README-DEV.md)**forcomplete development setup and workflow documentation.
318
273
@@ -321,15 +276,10 @@ If you\'re contributing to MCP for Unity or want to test core changes, we have d
321
276
Help make MCP for Unity better!
322
277
323
278
1. **Fork** the main repository.
324
-
325
279
2. **Create a branch** (`feature/your-idea` or `bugfix/your-fix`).
326
-
327
280
3. **Make changes.**
328
-
329
281
4. **Commit** (feat: Add cool new feature).
330
-
331
282
5. **Push** your branch.
332
-
333
283
6. **Open a Pull Request** against the main branch.
334
284
335
285
---
@@ -344,12 +294,18 @@ Help make MCP for Unity better!
344
294
- Check the status window: Window > MCP for Unity.
345
295
- Restart Unity.
346
296
- **MCP Client Not Connecting / Server Not Starting:**
347
-
- **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).
348
-
- **Verify uv:** Make sure `uv` is installed and working (pip show uv).
349
-
- **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`
350
-
- **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.
297
+
- **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location:
0 commit comments