From 2d3ec51a2b6241d4051531221d36b1eda0b74021 Mon Sep 17 00:00:00 2001 From: dsarno Date: Fri, 5 Sep 2025 11:08:58 -0700 Subject: [PATCH] Revise README for improved clarity and organization Updated section headings for clarity and consistency. Removed redundant instructions for Claude Code registration. --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 256c7d8..cdd93fb 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ MCP for Unity connects your tools using two components: **Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting. --- -### Step 1: 🌟Install the Unity Package🌟 +### 🌟 Step 1: Install the Unity Package #### To install via Git URL @@ -124,7 +124,7 @@ MCP for Unity connects your tools using two components: **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. -### 🛠️ Step 2: Configure Your MCP Client 🛠️ +### 🛠️ Step 2: Configure Your MCP Client Connect your MCP Client (Claude, Cursor, etc.) to the Python server set up in Step 1 (auto) or via Manual Configuration (below). MCPForUnity-Readme-Image @@ -154,6 +154,23 @@ If Auto-Setup fails or you use a different client:
Click for Client-Specific JSON Configuration Snippets... + --- +**Claude Code** + +If you're using Claude Code, you can register the MCP server using the below commands: +🚨**make sure to run these from your Unity project's home directory**🚨 + +**macOS:** + +```bash +claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py +``` + +**Windows:** + +```bash +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 +``` **VSCode (all OS)** ```json @@ -233,21 +250,7 @@ On Windows, set `command` to the absolute shim, e.g. `C:\\Users\\YOU\\AppData\\L (Replace YOUR_USERNAME) -**For Claude Code** -If you're using Claude Code, you can register the MCP server using these commands: - -**macOS:** - -```bash -claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py -``` - -**Windows:** - -```bash -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 -```
---