Fix: Rename UnityMCP to unityMCP in README

[sjjeong]

Description

Fixed a typo in the README where the MCP server name was incorrectly referenced as UnityMCP instead of unityMCP.

Problem

When configuring Claude Desktop using the README instructions, the incorrect server name UnityMCP caused the following error:

Error reading or parsing claude_desktop_config.json file: [
{
  "code": "invalid_type",
  "expected": "string",
  "received": "undefined",
  "path": ["mcpServers", "UnityMCP", "command"],
  "message": "Required"
}
]

Solution

Updated the README to use the correct server name unityMCP in the configuration example.

Changes

• Changed "UnityMCP" to "unityMCP" in the claude_desktop_config.json example

Testing

• ✅ Verified the corrected configuration works with Claude Desktop
• ✅ No more parsing errors

Summary by CodeRabbit

• Documentation
  • Updated configuration examples in the documentation for consistency.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md JSON configuration examples have been updated to standardize the server key name from "UnityMCP" to "unityMCP". This documentation change reflects naming convention consistency across multiple configuration example blocks.

Changes

Cohort / File(s)	Summary
Documentation Key Normalization README.md	Updated JSON configuration examples to use lowercase "unityMCP" instead of "UnityMCP" for the mcpServers key name across multiple config blocks

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

This is a straightforward documentation update with no logic changes or functional impact. Review consists of verifying the key-name consistency across all JSON examples in README.md.

Possibly related PRs

• Update README.md #212: Modifies README.md JSON configuration examples, aligning with this PR's documentation updates
• Config stability: preserve user configs, prefer installed server, safer uv resolution, XDG paths (Linux) #210: Normalizes VSCode/MCP config shape to use servers.unityMCP, supporting the lowercase naming convention now reflected in docs
• Windows UV stability: prefer WinGet Links, preserve pinned uv path; Claude Code unregister UI; add generic mcp_source.py #209: Updates code to detect and handle multiple server-name variants (UnityMCP, unityMCP, unity-mcp), providing runtime support for the documented lowercase form

Suggested reviewers

• msanatan

Poem

🐰 A little hop, a keystroke or two,
From UnityMCP to unityMCP so true,
Consistency reigns in the docs so bright,
Lowercase letters, everything just right!
✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: renaming 'UnityMCP' to 'unityMCP' in the README documentation, which is the core objective of this pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c2934a and 8399dc0.

📒 Files selected for processing (1)

• README.md (3 hunks)

🧰 Additional context used

🧠 Learnings (8)

📓 Common learnings

Learnt from: dsarno
Repo: CoplayDev/unity-mcp PR: 265
File: README.md:204-204
Timestamp: 2025-09-05T16:22:04.960Z
Learning: In the Unity MCP project, the ServerInstaller.cs creates a symlink from ~/Library/AppSupport to ~/Library/Application Support on macOS to mitigate argument parsing and quoting issues in some MCP clients. The README documentation should use the shortened AppSupport path, not the full "Application Support" path with spaces.

Learnt from: dsarno
Repo: CoplayDev/unity-mcp PR: 265
File: README.md:204-204
Timestamp: 2025-09-05T16:22:04.960Z
Learning: In the Unity MCP project, the ServerInstaller.cs creates a symlink from ~/Library/AppSupport to ~/Library/Application Support on macOS to mitigate argument parsing and quoting issues in some MCP clients. The README documentation should use the shortened AppSupport path, not the full "Application Support" path with spaces.

Learnt from: dsarno
Repo: CoplayDev/unity-mcp PR: 265
File: README.md:204-204
Timestamp: 2025-09-05T16:22:04.960Z
Learning: In the Unity MCP project, the ServerInstaller.cs creates a symlink from ~/Library/AppSupport to ~/Library/Application Support on macOS to avoid spaces in paths that can cause arg parsing and quoting issues in some MCP clients. The README documentation should use the shortened AppSupport path, not the full "Application Support" path.

Learnt from: msanatan
Repo: CoplayDev/unity-mcp PR: 368
File: MCPForUnity/UnityMcpServer~/src/resources/menu_items.py:15-15
Timestamp: 2025-11-05T18:23:12.349Z
Learning: In Unity MCP, the `name` parameter in the `mcp_for_unity_resource` decorator is the external API name exposed to MCP clients (LLMs, AI agents). The command string passed to `async_send_command_with_retry` or `async_send_with_unity_instance` (e.g., "get_menu_items") is the internal command identifier that must match the C# side. These are decoupled, allowing external API naming to evolve independently of internal command routing.

Learnt from: msanatan
Repo: CoplayDev/unity-mcp PR: 316
File: TestProjects/UnityMCPTests/Assets/Tests/EditMode/Resources.meta:1-8
Timestamp: 2025-10-13T13:27:23.040Z
Learning: UnityMcpBridge is a legacy project kept for backwards compatibility; MCPForUnity is the only active Unity plugin project. GUID collisions between UnityMcpBridge and MCPForUnity are acceptable.

📚 Learning: 2025-09-04T01:01:11.927Z

Learnt from: dsarno
Repo: CoplayDev/unity-mcp PR: 260
File: UnityMcpBridge/UnityMcpServer~/src/server_version.txt:1-1
Timestamp: 2025-09-04T01:01:11.927Z
Learning: The UnityMcpBridge project is not maintaining changelogs yet, so don't suggest adding changelog entries for version bumps.

Applied to files:

• README.md

📚 Learning: 2025-11-27T21:09:35.011Z

Learnt from: msanatan
Repo: CoplayDev/unity-mcp PR: 401
File: MCPForUnity/Editor/Clients/Configurators/VSCodeConfigurator.cs:10-18
Timestamp: 2025-11-27T21:09:35.011Z
Learning: VS Code GitHub Copilot MCP configuration supports mcp.json files placed directly in the Code/User directory: %APPDATA%\Code\User\mcp.json on Windows, ~/Library/Application Support/Code/User/mcp.json on macOS, and ~/.config/Code/User/mcp.json on Linux. This is in addition to workspace-scoped .vscode/mcp.json files.

Applied to files:

• README.md

📚 Learning: 2025-10-13T13:27:23.040Z

Learnt from: msanatan
Repo: CoplayDev/unity-mcp PR: 316
File: TestProjects/UnityMCPTests/Assets/Tests/EditMode/Resources.meta:1-8
Timestamp: 2025-10-13T13:27:23.040Z
Learning: UnityMcpBridge is a legacy project kept for backwards compatibility; MCPForUnity is the only active Unity plugin project. GUID collisions between UnityMcpBridge and MCPForUnity are acceptable.

Applied to files:

• README.md

📚 Learning: 2025-11-05T18:23:12.349Z

Learnt from: msanatan
Repo: CoplayDev/unity-mcp PR: 368
File: MCPForUnity/UnityMcpServer~/src/resources/menu_items.py:15-15
Timestamp: 2025-11-05T18:23:12.349Z
Learning: In Unity MCP, the `name` parameter in the `mcp_for_unity_resource` decorator is the external API name exposed to MCP clients (LLMs, AI agents). The command string passed to `async_send_command_with_retry` or `async_send_with_unity_instance` (e.g., "get_menu_items") is the internal command identifier that must match the C# side. These are decoupled, allowing external API naming to evolve independently of internal command routing.

Applied to files:

• README.md

📚 Learning: 2025-10-13T13:41:00.086Z

Learnt from: JohanHoltby
Repo: CoplayDev/unity-mcp PR: 309
File: MCPForUnity/Editor/Helpers/ServerInstaller.cs:478-508
Timestamp: 2025-10-13T13:41:00.086Z
Learning: In the MCPForUnityTools feature (MCPForUnity/Editor/Helpers/ServerInstaller.cs), the design intentionally forces users to have only one .py file per MCPForUnityTools folder to keep file tracking simple. Package-style tools (subdirectories with __init__.py) are not supported.

Applied to files:

• README.md

📚 Learning: 2025-09-05T16:22:04.960Z

Learnt from: dsarno
Repo: CoplayDev/unity-mcp PR: 265
File: README.md:204-204
Timestamp: 2025-09-05T16:22:04.960Z
Learning: In the Unity MCP project, the ServerInstaller.cs creates a symlink from ~/Library/AppSupport to ~/Library/Application Support on macOS to mitigate argument parsing and quoting issues in some MCP clients. The README documentation should use the shortened AppSupport path, not the full "Application Support" path with spaces.

Applied to files:

• README.md

📚 Learning: 2025-09-05T16:22:04.960Z

Learnt from: dsarno
Repo: CoplayDev/unity-mcp PR: 265
File: README.md:204-204
Timestamp: 2025-09-05T16:22:04.960Z
Learning: In the Unity MCP project, the ServerInstaller.cs creates a symlink from ~/Library/AppSupport to ~/Library/Application Support on macOS to avoid spaces in paths that can cause arg parsing and quoting issues in some MCP clients. The README documentation should use the shortened AppSupport path, not the full "Application Support" path.

Applied to files:

• README.md

🔇 Additional comments (2)

README.md (2)

249-249: ✅ Configuration examples standardized to lowercase unityMCP.

The JSON configuration keys have been consistently updated across HTTP and stdio transports (Claude Desktop, macOS/Linux, Windows). The changes align with your testing and resolve Claude Desktop parsing errors.

Also applies to: 288-288, 308-308

---

223-223: Consider aligning Claude Code command naming for consistency.

The claude mcp add commands on lines 223 and 229 still reference UnityMCP (capitalized), while the configuration examples now use unityMCP (lowercase). Verify whether this is intentional—if UnityMCP is the formal server registration name in Claude Code, no change is needed. If it should match the config key naming, these should also be updated to unityMCP.

Also applies to: 229-229

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[dsarno]

Thanks!