Skip to content

Commit 2d3ec51

Browse files
authored
Revise README for improved clarity and organization
Updated section headings for clarity and consistency. Removed redundant instructions for Claude Code registration.
1 parent 94fcff4 commit 2d3ec51

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ MCP for Unity connects your tools using two components:
102102
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.</details>
103103

104104
---
105-
### Step 1: 🌟Install the Unity Package🌟
105+
### 🌟 Step 1: Install the Unity Package
106106

107107
#### To install via Git URL
108108

@@ -124,7 +124,7 @@ MCP for Unity connects your tools using two components:
124124

125125
**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.
126126
127-
### 🛠️ Step 2: Configure Your MCP Client 🛠️
127+
### 🛠️ Step 2: Configure Your MCP Client
128128
Connect your MCP Client (Claude, Cursor, etc.) to the Python server set up in Step 1 (auto) or via Manual Configuration (below).
129129
130130
<img width="648" height="599" alt="MCPForUnity-Readme-Image" src="https://github.com/user-attachments/assets/b4a725da-5c43-4bd6-80d6-ee2e3cca9596" />
@@ -154,6 +154,23 @@ If Auto-Setup fails or you use a different client:
154154
<details>
155155
<summary><strong>Click for Client-Specific JSON Configuration Snippets...</strong></summary>
156156

157+
---
158+
**Claude Code**
159+
160+
If you're using Claude Code, you can register the MCP server using the below commands:
161+
🚨**make sure to run these from your Unity project's home directory**🚨
162+
163+
**macOS:**
164+
165+
```bash
166+
claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py
167+
```
168+
169+
**Windows:**
170+
171+
```bash
172+
claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Local/Microsoft/WinGet/Links/uv.exe" --directory "C:/Users/USERNAME/AppData/Local/UnityMCP/UnityMcpServer/src" run server.py
173+
```
157174
**VSCode (all OS)**
158175

159176
```json
@@ -233,21 +250,7 @@ On Windows, set `command` to the absolute shim, e.g. `C:\\Users\\YOU\\AppData\\L
233250

234251
(Replace YOUR_USERNAME)
235252

236-
**For Claude Code**
237253

238-
If you're using Claude Code, you can register the MCP server using these commands:
239-
240-
**macOS:**
241-
242-
```bash
243-
claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py
244-
```
245-
246-
**Windows:**
247-
248-
```bash
249-
claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Local/Microsoft/WinGet/Links/uv.exe" --directory "C:/Users/USERNAME/AppData/Local/UnityMCP/UnityMcpServer/src" run server.py
250-
```
251254
</details>
252255

253256
---

0 commit comments

Comments
 (0)