Update * Clean up README, fix install paths, add logo #265
Conversation
- Windows: Fix path from AppData\Local\Programs\UnityMCP to AppData\Local\UnityMCP - macOS: Update from /usr/local/bin/UnityMCP to Library/AppSupport/UnityMCP (uses symlink) - Linux: Change from /home/USERNAME/bin/UnityMCP to .local/share/UnityMCP - Update Claude Code command examples with correct paths 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. WalkthroughREADME.md rewritten: visual branding updated (hero image), Available Tools list expanded, installation/prerequisites and setup flow rewritten (Unity Hub/Editor, Python/uv, Roslyn, Git/OpenUPM paths), Auto-Setup vs Manual Configuration added with OS-specific JSON/path examples, troubleshooting and contributing sections reorganized, example prompts updated. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
154-167: Fix incorrect backslashes in macOS/Linux path examples in README.md
In the “Verify Server Path” section (around lines 295–306), the macOS and Linux examples use Windows-style backslashes. ReplaceUnityMcpServer\srcwithUnityMcpServer/src:
- macOS:
~/Library/AppSupport/UnityMCP/UnityMcpServer/src- Linux:
~/.local/share/UnityMCP/UnityMcpServer/src
🧹 Nitpick comments (4)
README.md (4)
75-76: Fix double colon and minor label.Remove the extra colon and use a shorter label for VS Code Copilot.
- * **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 + * **An MCP Client:** [Claude Desktop](https://claude.ai/download) | [Claude Code](https://github.com/anthropics/claude-code) | [Cursor](https://www.cursor.com/en/downloads) | [VS Code Copilot](https://code.visualstudio.com/docs/copilot/overview) | [Windsurf](https://windsurf.com) | Others work with manual config
158-160: uv args order (consistency).Prefer the canonical ordering:
uv run --directory ... server.py.- "args": ["--directory","<ABSOLUTE_PATH_TO>/UnityMcpServer/src","run","server.py"], + "args": ["run","--directory","<ABSOLUTE_PATH_TO>/UnityMcpServer/src","server.py"],
208-208: Clarify note about spaces in paths.JSON strings handle spaces; no symlink is needed.
-(Replace YOUR_USERNAME. Note: AppSupport is a symlink to "Application Support" to avoid quoting issues) +(Replace YOUR_USERNAME. Paths with spaces are fine in JSON strings; no symlink is required.)
131-133: Optional: mention client restart.Some clients read configs only on launch; suggest restart if the green status doesn’t appear.
-3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client's config file automatically).* +3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client's config file automatically. If not visible, restart your MCP client and retry.)*
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(17 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~20-~20: There might be a mistake here.
Context: ...in Unity. --- ### 💬 Join Our Discord **Get help, share ideas, and collaborate w...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...queries the editor's state and settings. * manage_scene: Manages scenes (load, save, create, ge...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...> --- ### 🌟Install the Unity Package🌟 #### To install via Git URL 1. Open your Un...
(QB_NEW_EN)
[grammar] ~262-~262: There might be a mistake here.
Context: ... --- ## Development & Contributing 🛠️ ### For Developers If you're contributing t...
(QB_NEW_EN)
[grammar] ~307-~307: There might be a mistake here.
Context: ....py ``` - Auto-Configure Failed: - Use the Manual Configuration steps. Auto...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
40-40: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
75-75: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
297-297: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
297-297: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
298-298: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
298-298: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
299-299: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
299-299: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
300-300: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
300-300: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
301-301: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
301-301: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
302-302: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
307-307: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
308-308: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
308-308: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (2)
README.md (2)
108-112: Git URL subpath looks correct.The scoped path
/UnityMcpBridgeis valid for Package Manager Git installs.
168-186: Windows JSON config LGTM.Uses escaped backslashes and puts
run --directory ... server.pyin args correctly.
| "args": [ | ||
| "run", | ||
| "--directory", | ||
| "/usr/local/bin/UnityMCP/UnityMcpServer/src", | ||
| "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", | ||
| "server.py" | ||
| ] |
There was a problem hiding this comment.
macOS path: use “Application Support”, not “AppSupport”.
“AppSupport” isn’t a standard path and will 404 on most systems.
- "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src",
+ "/Users/YOUR_USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "args": [ | |
| "run", | |
| "--directory", | |
| "/usr/local/bin/UnityMCP/UnityMcpServer/src", | |
| "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", | |
| "server.py" | |
| ] | |
| "args": [ | |
| "run", | |
| "--directory", | |
| "/Users/YOUR_USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src", | |
| "server.py" | |
| ] |
🤖 Prompt for AI Agents
In README.md around lines 196 to 201, the macOS path uses "AppSupport" which is
nonstandard; update the path segment to "Application Support" (i.e.,
"/Users/YOUR_USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src")
so the example points to the correct directory on macOS and will resolve
correctly for users.
| - **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location: | ||
| - **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` | ||
| - **macOS:** `~/Library/AppSupport/UnityMCP/UnityMcpServer\src` | ||
| - **Linux:** `~/.local/share/UnityMCP/UnityMcpServer\src` | ||
| - **Verify uv:** Make sure `uv` is installed and working (`uv --version`). | ||
| - **Run Manually:** Try running the server directly from the terminal to see errors: | ||
| ```bash | ||
| cd /path/to/your/UnityMCP/UnityMcpServer/src | ||
| uv run server.py | ||
| ``` |
There was a problem hiding this comment.
Troubleshooting: fix macOS/Linux paths and list style.
Correct slashes and standardize bullets to satisfy markdownlint.
- - **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location:
- - **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src`
- - **macOS:** `~/Library/AppSupport/UnityMCP/UnityMcpServer\src`
- - **Linux:** `~/.local/share/UnityMCP/UnityMcpServer\src`
- - **Verify uv:** Make sure `uv` is installed and working (`uv --version`).
- - **Run Manually:** Try running the server directly from the terminal to see errors:
+ * **Verify Server Path:** Double-check the `--directory` path in your MCP Client's JSON config. It must exactly match the installation location:
+ * **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src`
+ * **macOS:** `~/Library/Application Support/UnityMCP/UnityMcpServer/src`
+ * **Linux:** `~/.local/share/UnityMCP/UnityMcpServer/src`
+ * **Verify uv:** Make sure `uv` is installed and working (`uv --version`).
+ * **Run Manually:** Try running the server directly from the terminal to see errors:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location: | |
| - **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` | |
| - **macOS:** `~/Library/AppSupport/UnityMCP/UnityMcpServer\src` | |
| - **Linux:** `~/.local/share/UnityMCP/UnityMcpServer\src` | |
| - **Verify uv:** Make sure `uv` is installed and working (`uv --version`). | |
| - **Run Manually:** Try running the server directly from the terminal to see errors: | |
| ```bash | |
| cd /path/to/your/UnityMCP/UnityMcpServer/src | |
| uv run server.py | |
| ``` | |
| * **Verify Server Path:** Double-check the `--directory` path in your MCP Client's JSON config. It must exactly match the installation location: | |
| * **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` | |
| * **macOS:** `~/Library/Application Support/UnityMCP/UnityMcpServer/src` | |
| * **Linux:** `~/.local/share/UnityMCP/UnityMcpServer/src` | |
| * **Verify uv:** Make sure `uv` is installed and working (`uv --version`). | |
| * **Run Manually:** Try running the server directly from the terminal to see errors: |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
297-297: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
297-297: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
298-298: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
298-298: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
299-299: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
299-299: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
300-300: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
300-300: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
301-301: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
301-301: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
302-302: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
70-74: Don't instruct users to install uv via pip; provide official installers.The pip package isn't the supported way to install the uv CLI and can lead to a broken setup. Replace with the official install methods and keep the docs link.
Apply:
- * **uv (Python package manager):** - ```bash - pip install uv - # Or see: https://docs.astral.sh/uv/getting-started/installation/ - ``` + * **uv (Python toolchain manager):** + ```bash + # macOS / Linux + curl -LsSf https://astral.sh/uv/install.sh | sh + + # Windows (PowerShell) + winget install Astral.Sh.Uv + + # Docs: https://docs.astral.sh/uv/getting-started/installation/ + ```
♻️ Duplicate comments (3)
README.md (3)
297-306: Troubleshooting: correct macOS/Linux paths, slashes, and list style.- - **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location: - - **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` - - **macOS:** `~/Library/AppSupport/UnityMCP/UnityMcpServer\src` - - **Linux:** `~/.local/share/UnityMCP/UnityMcpServer\src` - - **Verify uv:** Make sure `uv` is installed and working (`uv --version`). - - **Run Manually:** Try running the server directly from the terminal to see errors: + * **Verify Server Path:** Double-check the `--directory` path in your MCP Client's JSON config. It must exactly match the installation location: + * **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` + * **macOS:** `~/Library/Application Support/UnityMCP/UnityMcpServer/src` + * **Linux:** `~/.local/share/UnityMCP/UnityMcpServer/src` + * **Verify uv:** Make sure `uv` is installed and working (`uv --version`). + * **Run Manually:** Try running the server directly from the terminal to see errors: ```bash - cd /path/to/your/UnityMCP/UnityMcpServer/src + cd "/path/to/your/UnityMCP/UnityMcpServer/src" uv run server.py ```
199-201: macOS path: use “Application Support”, not “AppSupport”; also quote paths with spaces.- "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", + "/Users/YOUR_USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src",-(Replace YOUR_USERNAME. Note: AppSupport is a symlink to "Application Support" to avoid quoting issues) +(Replace YOUR_USERNAME. Tip: quote paths with spaces, e.g., "/Users/YOUR_USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src")Also applies to: 208-208
238-245: Claude Code commands: fix macOS path and quote it. Windows line is good.-claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py +claude mcp add UnityMCP -- uv --directory "/Users/USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src" run server.py
🧹 Nitpick comments (3)
README.md (3)
75-76: Fix extra colon and tighten wording.- * **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 + * **An MCP Client:** [Claude Desktop](https://claude.ai/download) | [Claude Code](https://github.com/anthropics/claude-code) | [Cursor](https://www.cursor.com/en/downloads) | [VS Code Copilot](https://code.visualstudio.com/docs/copilot/overview) | [Windsurf](https://windsurf.com) | others via manual config
40-40: List indentation: align with surrounding bullets.Removes leading spaces to satisfy markdownlint (MD007) and keep consistency.
- * `manage_editor`: Controls and queries the editor's state and settings. +* `manage_editor`: Controls and queries the editor's state and settings.
171-185: Normalize uv args order across snippets.Use the same form everywhere for clarity: uv --directory run server.py.
"args": [ - "run", - "--directory", - "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\UnityMCP\\UnityMcpServer\\src", - "server.py" + "--directory", + "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\UnityMCP\\UnityMcpServer\\src", + "run", + "server.py" ]Please quickly verify that this works in your environment with uv (both forms may work, but consistency helps).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(16 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~20-~20: There might be a mistake here.
Context: ...in Unity. --- ### 💬 Join Our Discord **Get help, share ideas, and collaborate w...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...queries the editor's state and settings. * manage_scene: Manages scenes (load, save, create, ge...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...## Step 1: 🌟Install the Unity Package🌟 #### To install via Git URL 1. Open your Un...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...?️ Step 2: Configure Your MCP Client 🛠️ e w Connect your MCP Client (Claude, Cursor...
(QB_NEW_EN)
[grammar] ~262-~262: There might be a mistake here.
Context: ... --- ## Development & Contributing 🛠️ ### For Developers If you're contributing t...
(QB_NEW_EN)
[grammar] ~307-~307: There might be a mistake here.
Context: ....py ``` - Auto-Configure Failed: - Use the Manual Configuration steps. Auto...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
40-40: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
75-75: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
297-297: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
297-297: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
298-298: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
298-298: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
299-299: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
299-299: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
300-300: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
300-300: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
301-301: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
301-301: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
302-302: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
307-307: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
308-308: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
308-308: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
README.md (2)
215-221: Reorderuvargs in the Linux JSON snippet to match other examples.- "args": [ - "run", - "--directory", - "/home/YOUR_USERNAME/.local/share/UnityMCP/UnityMcpServer/src", - "server.py" - ] + "args": [ + "--directory", + "/home/YOUR_USERNAME/.local/share/UnityMCP/UnityMcpServer/src", + "run", + "server.py" + ]
191-201: Reorder uv args in macOS JSON snippet
In README.md (around lines 191–201), update the macOSargsarray to match the VSCode example by placing--directorybeforerun:@@ README.md:191-201 "args": [ - "run", - "--directory", - "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", - "server.py" + "--directory", + "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", + "run", + "server.py" ]
♻️ Duplicate comments (2)
README.md (2)
237-237: Claude Code (macOS): quote the path and use “Application Support”.Prevents breakage due to spaces and fixes the folder name.
-claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py +claude mcp add UnityMCP -- uv --directory "/Users/USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src" run server.py
296-305: Troubleshooting: fix list style and OS paths (slashes, macOS folder name).Correcting these avoids 404 paths and satisfies markdownlint.
- - **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location: - - **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` - - **macOS:** `~/Library/AppSupport/UnityMCP/UnityMcpServer\src` - - **Linux:** `~/.local/share/UnityMCP/UnityMcpServer\src` - - **Verify uv:** Make sure `uv` is installed and working (`uv --version`). - - **Run Manually:** Try running the server directly from the terminal to see errors: + * **Verify Server Path:** Double-check the `--directory` path in your MCP Client's JSON config. It must exactly match the installation location: + * **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` + * **macOS:** `~/Library/Application Support/UnityMCP/UnityMcpServer/src` + * **Linux:** `~/.local/share/UnityMCP/UnityMcpServer/src` + * **Verify uv:** Make sure `uv` is installed and working (`uv --version`). + * **Run Manually:** Try running the server directly from the terminal to see errors:
🧹 Nitpick comments (2)
README.md (2)
75-75: Minor: remove extra colon and fix list indentation.Cleans up rendering and satisfies MD007.
- * **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 +* **An MCP Client:** [Claude Desktop](https://claude.ai/download) | [Claude Code](https://github.com/anthropics/claude-code) | [Cursor](https://www.cursor.com/en/downloads) | [VS Code Copilot](https://code.visualstudio.com/docs/copilot/overview) | [Windsurf](https://windsurf.com) | Others with manual config
38-49: Normalize bullet indentation under “Available Tools”.Unindent bullets one level to satisfy markdownlint (MD007) and render consistently.
- * `read_console`: Gets messages from or clears the console. - * `manage_script`: Manages C# scripts (create, read, update, delete). - * `manage_editor`: Controls and queries the editor's state and settings. - * `manage_scene`: Manages scenes (load, save, create, get hierarchy, etc.). - * `manage_asset`: Performs asset operations (import, create, modify, delete, etc.). - * `manage_shader`: Performs shader CRUD operations (create, read, modify, delete). - * `manage_gameobject`: Manages GameObjects: create, modify, delete, find, and component operations. - * `execute_menu_item`: Executes a menu item via its path (e.g., "File/Save Project"). - * `apply_text_edits`: Precise text edits with precondition hashes and atomic multi-edit batches. - * `script_apply_edits`: Structured C# method/class edits (insert/replace/delete) with safer boundaries. - * `validate_script`: Fast validation (basic/standard) to catch syntax/structure issues before/after writes. +* `read_console`: Gets messages from or clears the console. +* `manage_script`: Manages C# scripts (create, read, update, delete). +* `manage_editor`: Controls and queries the editor's state and settings. +* `manage_scene`: Manages scenes (load, save, create, get hierarchy, etc.). +* `manage_asset`: Performs asset operations (import, create, modify, delete, etc.). +* `manage_shader`: Performs shader CRUD operations (create, read, modify, delete). +* `manage_gameobject`: Manages GameObjects: create, modify, delete, find, and component operations. +* `execute_menu_item`: Executes a menu item via its path (e.g., "File/Save Project"). +* `apply_text_edits`: Precise text edits with precondition hashes and atomic multi-edit batches. +* `script_apply_edits`: Structured C# method/class edits (insert/replace/delete) with safer boundaries. +* `validate_script`: Fast validation (basic/standard) to catch syntax/structure issues before/after writes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(16 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~20-~20: There might be a mistake here.
Context: ...in Unity. --- ### 💬 Join Our Discord **Get help, share ideas, and collaborate w...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...queries the editor's state and settings. * manage_scene: Manages scenes (load, save, create, ge...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...## Step 1: 🌟Install the Unity Package🌟 #### To install via Git URL 1. Open your Un...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...?️ Step 2: Configure Your MCP Client 🛠️ Connect your MCP Client (Claude, Cursor,...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ... --- ## Development & Contributing 🛠️ ### For Developers If you're contributing t...
(QB_NEW_EN)
[grammar] ~306-~306: There might be a mistake here.
Context: ....py ``` - Auto-Configure Failed: - Use the Manual Configuration steps. Auto...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
40-40: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
75-75: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
296-296: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
296-296: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
297-297: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
297-297: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
298-298: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
298-298: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
299-299: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
299-299: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
300-300: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
300-300: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
301-301: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
301-301: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
306-306: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
307-307: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
307-307: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (1)
README.md (1)
169-179: Standardize uv global option orderingMove
--directory <path>before therunsubcommand in all three code blocks so global options precede subcommands. For example:- "args": [ - "run", - "--directory", - "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\UnityMCP\\UnityMcpServer\\src", - "server.py" - ] + "args": [ + "--directory", + "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\UnityMCP\\UnityMcpServer\\src", + "run", + "server.py" + ]Verify that
uvaccepts this ordering on Windows, macOS, and Linux before updating the other blocks.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
README.md (3)
204-206: macOS path: use “Application Support”, not “AppSupport”.“AppSupport” isn’t standard and will fail for most users. JSON strings handle spaces fine.
- "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", + "/Users/YOUR_USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src",-(Replace YOUR_USERNAME. Note: AppSupport is a symlink to "Application Support" to avoid quoting issues) +(Replace YOUR_USERNAME. macOS uses “Application Support”. JSON strings can include spaces without escaping.)Also applies to: 213-213
243-244: Claude Code (macOS): quote path and fix “AppSupport”.Without quotes, the command breaks on the space; also “AppSupport” is invalid.
-claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py +claude mcp add UnityMCP -- uv --directory "/Users/USERNAME/Library/Application Support/UnityMCP/UnityMcpServer/src" run server.py
302-311: Troubleshooting: fix paths, slashes, and list style for readability and correctness.Backslashes appear in POSIX paths; macOS folder name is wrong; markdown list style is inconsistent with earlier sections.
-- **MCP Client Not Connecting / Server Not Starting:** - - **Verify Server Path:** Double-check the --directory path in your MCP Client's JSON config. It must exactly match the installation location: - - **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` - - **macOS:** `~/Library/AppSupport/UnityMCP/UnityMcpServer\src` - - **Linux:** `~/.local/share/UnityMCP/UnityMcpServer\src` - - **Verify uv:** Make sure `uv` is installed and working (`uv --version`). - - **Run Manually:** Try running the server directly from the terminal to see errors: - ```bash - cd /path/to/your/UnityMCP/UnityMcpServer/src - uv run server.py - ``` +- **MCP Client Not Connecting / Server Not Starting:** + * **Verify Server Path:** Double-check the `--directory` path in your MCP Client's JSON config. It must exactly match the installation location: + * **Windows:** `%USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src` + * **macOS:** `~/Library/Application Support/UnityMCP/UnityMcpServer/src` + * **Linux:** `~/.local/share/UnityMCP/UnityMcpServer/src` + * **Verify uv:** Make sure `uv` is installed and working (`uv --version`). + * **Run Manually:** Try running the server directly from the terminal to see errors: + ```bash + cd "/path/to/your/UnityMCP/UnityMcpServer/src" + uv run server.py + ```
🧹 Nitpick comments (3)
README.md (3)
81-82: Fix double colon in “An MCP Client” bullet.There’s an extra colon after the bold label.
- * **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 + * **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
263-263: Dedent “Example Prompt” line to avoid rendering as a code block.Right now it renders as a fenced code block, not prose with inline code.
- Example Prompt: `Create a 3D player controller`, `Create a tic-tac-toe game in 3D`, `Create a cool shader and apply to a cube`. +Example Prompt: `Create a 3D player controller`, `Create a tic-tac-toe game in 3D`, `Create a cool shader and apply to a cube`.
40-49: Optional: normalize list indentation inside the Tools details block.Minor markdownlint (MD007) warnings due to extra indentation. Not user-facing, but easy to tidy.
- * `manage_editor`: Controls and queries the editor's state and settings. +* `manage_editor`: Controls and queries the editor's state and settings.(Apply similarly to other items in this block if you want clean lint.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(15 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-04T01:01:11.889Z
Learnt from: dsarno
PR: CoplayDev/unity-mcp#260
File: UnityMcpBridge/UnityMcpServer~/src/server_version.txt:1-1
Timestamp: 2025-09-04T01:01:11.889Z
Learning: The UnityMcpBridge project is not maintaining changelogs yet, so don't suggest adding changelog entries for version bumps.
Applied to files:
README.md
🪛 LanguageTool
README.md
[grammar] ~20-~20: There might be a mistake here.
Context: ...in Unity. --- ### 💬 Join Our Discord **Get help, share ideas, and collaborate w...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...queries the editor's state and settings. * manage_scene: Manages scenes (load, save, create, ge...
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...ion 2021.3 LTS or newer. Download Unity * uv (Python toolchain manager): `...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...## Step 1: 🌟Install the Unity Package🌟 #### To install via Git URL 1. Open your Un...
(QB_NEW_EN)
[grammar] ~127-~127: There might be a mistake here.
Context: ...?️ Step 2: Configure Your MCP Client 🛠️ Connect your MCP Client (Claude, Cursor,...
(QB_NEW_EN)
[grammar] ~267-~267: There might be a mistake here.
Context: ... --- ## Development & Contributing 🛠️ ### For Developers If you're contributing t...
(QB_NEW_EN)
[grammar] ~312-~312: There might be a mistake here.
Context: ....py ``` - Auto-Configure Failed: - Use the Manual Configuration steps. Auto...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
40-40: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
68-68: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
69-69: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
70-70: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
81-81: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
302-302: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
303-303: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
303-303: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
304-304: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
304-304: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
305-305: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
305-305: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
306-306: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
306-306: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
307-307: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
307-307: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
312-312: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
313-313: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
313-313: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (1)
README.md (1)
1-18: Clear, modernized README — nice upgrade.Branding, structure, and setup flow are much clearer. Good call splitting Auto-Setup vs Manual.
Updated section headings for clarity and consistency. Removed redundant instructions for Claude Code registration.
1 participant
The README was getting a little long. I shortened, tightened, cleaned up, added logo and flow-chart. Removed "upcoming features." section because it was taking a lot of space
Summary by CodeRabbit