docs: replace "Unity MCP" with "MCP for Unity" in all text strings #314

msanatan · 2025-10-11T07:40:51Z

Summary by CodeRabbit

Documentation
- Updated terminology to “MCP for Unity” across guides and READMEs.
- Enhanced telemetry/privacy sections with a clear optionality note and link to detailed docs (including zh updates).
Style
- Renamed product references in installation recommendations, logs, and messages to “MCP for Unity.”
- Updated resource metadata name to reflect the new branding.
Tests
- Aligned test skip and error messages with the new naming for consistency.

coderabbitai · 2025-10-11T07:41:17Z

Walkthrough

Project-wide textual renames from “Unity MCP” to “MCP for Unity” across editor messages, docs, telemetry strings, tests, and tooling. One resource spec “name” field updated. No functional, control-flow, or API changes.

Changes

Cohort / File(s)	Change summary
Platform detectors (installer text) `MCPForUnity/Editor/Dependencies/PlatformDetectors/LinuxPlatformDetector.cs`, `.../MacOSPlatformDetector.cs`, `.../WindowsPlatformDetector.cs`	Updated installation recommendation strings to use “MCP for Unity”/“MCP for Unity Bridge”. No logic changes.
Editor services (XML docs only) `MCPForUnity/Editor/Services/IBridgeControlService.cs`, `MCPForUnity/Editor/Services/IClientConfigurationService.cs`	Renamed “Unity MCP (Bridge)” to “MCP for Unity (Bridge)” in documentation comments. No API/signature changes.
Server src (telemetry, connection, resources) `MCPForUnity/UnityMcpServer~/src/telemetry.py`, `.../telemetry_decorator.py`, `.../unity_connection.py`, `.../tools/resource_tools.py`, `.../test_telemetry.py`	Textual renames in docstrings/logs; resource_tools canonical spec “name” changed to “MCP for Unity - Script Edits v1”. No control-flow changes.
Docs (general, telemetry, dev guides) `README.md`, `README-zh.md`, `docs/TELEMETRY.md`, `docs/CUSTOM_TOOLS.md`, `docs/README-DEV.md`, `docs/README-DEV-zh.md`	Renamed product references to “MCP for Unity”; added/clarified privacy notes; minor added note about precondition_sha256 in zh dev readme. Text only.
Tests (messages/comments only) `tests/test_logging_stdout.py`, `tests/test_manage_script_uri.py`, `tests/test_resources_api.py`, `tests/test_telemetry_subaction.py`, `tests/test_transport_framing.py`	Updated skip messages/comments from “Unity MCP” to “MCP for Unity”. No test logic changes.
Tooling `tools/stress_mcp.py`	Updated argparse description to “MCP for Unity”. No behavioral changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Added optional telemetry #264 — Also touches telemetry modules and related tests; likely adjacent to these terminology updates.
Fix: Unity Editor reload crash + debug-noise reduction #266 — Modifies stress_mcp.py and docs, overlapping with this PR’s terminology changes.

Suggested reviewers

justinpbarnett
dsarno

Poem

I hop through logs and docs so spry,
Renaming clouds that drifted by.
No codepaths twist, no branches sprout—
Just tidy words, swapped in and out.
Thump-thump! My review is light—
MCP for Unity, named just right. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title concisely captures the primary branding change of replacing “Unity MCP” with “MCP for Unity” across text strings, but the “docs:” prefix misleadingly implies the updates are limited to documentation even though code, tests, and configuration files were also modified.	Update the prefix to reflect a broader scope (for example using “chore:”) and clarify that the rename applies across code, tests, and documentation, for instance “chore: rename Unity MCP to MCP for Unity across code, tests, and docs.”
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

📝 Generate docstrings

🧪 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 6b0ee30 and 75c5128.

📒 Files selected for processing (22)

MCPForUnity/Editor/Dependencies/PlatformDetectors/LinuxPlatformDetector.cs (1 hunks)
MCPForUnity/Editor/Dependencies/PlatformDetectors/MacOSPlatformDetector.cs (1 hunks)
MCPForUnity/Editor/Dependencies/PlatformDetectors/WindowsPlatformDetector.cs (1 hunks)
MCPForUnity/Editor/Services/IBridgeControlService.cs (2 hunks)
MCPForUnity/Editor/Services/IClientConfigurationService.cs (1 hunks)
MCPForUnity/UnityMcpServer~/src/telemetry.py (2 hunks)
MCPForUnity/UnityMcpServer~/src/telemetry_decorator.py (1 hunks)
MCPForUnity/UnityMcpServer~/src/test_telemetry.py (1 hunks)
MCPForUnity/UnityMcpServer~/src/tools/resource_tools.py (1 hunks)
MCPForUnity/UnityMcpServer~/src/unity_connection.py (1 hunks)
README-zh.md (1 hunks)
README.md (2 hunks)
docs/CUSTOM_TOOLS.md (1 hunks)
docs/README-DEV-zh.md (2 hunks)
docs/README-DEV.md (2 hunks)
docs/TELEMETRY.md (3 hunks)
tests/test_logging_stdout.py (1 hunks)
tests/test_manage_script_uri.py (1 hunks)
tests/test_resources_api.py (1 hunks)
tests/test_telemetry_subaction.py (1 hunks)
tests/test_transport_framing.py (1 hunks)
tools/stress_mcp.py (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📚 Learning: 2025-10-03T22:11:46.002Z

Learnt from: msanatan
PR: CoplayDev/unity-mcp#301
File: docs/CUSTOM_TOOLS.md:54-62
Timestamp: 2025-10-03T22:11:46.002Z
Learning: In Unity MCP, the `description` parameter in the `mcp_for_unity_tool` decorator is technically optional but should always be included as a best practice. Without it, there's a higher chance that MCP clients will not parse the tool correctly. All Unity MCP tools should include the description in the decorator for compatibility.

Applied to files:

tools/stress_mcp.py
docs/CUSTOM_TOOLS.md
MCPForUnity/UnityMcpServer~/src/telemetry_decorator.py

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

Learnt from: dsarno
PR: CoplayDev/unity-mcp#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:

MCPForUnity/Editor/Dependencies/PlatformDetectors/LinuxPlatformDetector.cs
MCPForUnity/Editor/Dependencies/PlatformDetectors/MacOSPlatformDetector.cs

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

Learnt from: dsarno
PR: CoplayDev/unity-mcp#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:

MCPForUnity/Editor/Dependencies/PlatformDetectors/LinuxPlatformDetector.cs
MCPForUnity/Editor/Dependencies/PlatformDetectors/MacOSPlatformDetector.cs

🧬 Code graph analysis (2)

MCPForUnity/Editor/Services/IClientConfigurationService.cs (1)

MCPForUnity/Editor/Services/ClientConfigurationService.cs (1)

RegisterClaudeCode (233-298)

MCPForUnity/Editor/Services/IBridgeControlService.cs (1)

MCPForUnity/Editor/Services/BridgeControlService.cs (1)

Start (18-31)

🪛 Ruff (0.13.3)

MCPForUnity/UnityMcpServer~/src/unity_connection.py

94-95: Avoid specifying long messages outside the exception class

(TRY003)

🔇 Additional comments (34)

MCPForUnity/Editor/Dependencies/PlatformDetectors/MacOSPlatformDetector.cs (1)

101-101: LGTM!

The text update from "Unity MCP Bridge" to "MCP for Unity Bridge" is correct and consistent with the rebranding objective.

tests/test_telemetry_subaction.py (1)

5-5: LGTM!

The comment update correctly reflects the new project naming convention.

tests/test_logging_stdout.py (1)

17-17: LGTM!

The skip message correctly reflects the rebranded project name.

MCPForUnity/Editor/Dependencies/PlatformDetectors/LinuxPlatformDetector.cs (1)

100-100: LGTM!

The text update from "Unity MCP" to "MCP for Unity" is correct and aligns with the project-wide rebranding.

MCPForUnity/UnityMcpServer~/src/telemetry_decorator.py (1)

2-2: LGTM!

The module docstring correctly reflects the updated project naming.

tests/test_resources_api.py (1)

20-20: LGTM!

The skip message correctly reflects the rebranded project name.

tools/stress_mcp.py (1)

315-315: LGTM!

The CLI description text is correctly updated to reflect the new project name. Note that protocol-level constants (e.g., handshake message on line 81) are appropriately left unchanged for backward compatibility.

docs/CUSTOM_TOOLS.md (1)

1-3: LGTM!

The documentation title and description are correctly updated to reflect the rebranded project name.

README-zh.md (1)

302-308: LGTM! Branding update is consistent.

The privacy and telemetry section has been correctly updated to use "MCP for Unity" branding, and the added transparency details improve user communication.

docs/README-DEV-zh.md (2)

108-108: LGTM! Consistent branding update.

The developer documentation correctly reflects the new "MCP for Unity" branding in the bridge description.

184-184: LGTM! UI reference updated correctly.

The window reference has been updated to match the new branding.

MCPForUnity/UnityMcpServer~/src/test_telemetry.py (1)

3-3: LGTM! Test documentation updated.

The module docstring correctly reflects the new branding with no impact on test functionality.

MCPForUnity/Editor/Services/IClientConfigurationService.cs (1)

31-31: LGTM! API documentation updated correctly.

The XML documentation comments for Claude Code CLI integration methods have been updated to reflect the new branding with no changes to method signatures or behavior.

Also applies to: 36-36

tests/test_manage_script_uri.py (1)

19-19: LGTM! Test skip message updated.

The skip message correctly uses the new branding with no impact on test behavior.

MCPForUnity/Editor/Dependencies/PlatformDetectors/WindowsPlatformDetector.cs (1)

104-104: LGTM! Installation guidance updated.

The user-facing installation recommendation text correctly reflects the new branding with no changes to platform detection logic.

MCPForUnity/UnityMcpServer~/src/tools/resource_tools.py (1)

211-211: LGTM! Resource metadata updated consistently.

The canonical resource spec "name" field has been updated to reflect the new branding. While this metadata may be visible to MCP clients, it's a pure branding change with no functional impact on the spec structure or tool behavior.

MCPForUnity/UnityMcpServer~/src/telemetry.py (2)

2-2: LGTM! Module documentation updated.

The telemetry module docstring correctly reflects the new branding.

331-331: LGTM! Version comment updated.

The inline comment for the version field has been updated to match the new branding with no changes to the actual version value or telemetry payload structure.

tests/test_transport_framing.py (1)

23-23: LGTM! Branding update is consistent.

The skip message correctly reflects the new "MCP for Unity" naming convention. The change is purely textual with no impact on test logic.

docs/README-DEV.md (2)

108-108: LGTM! Documentation updated correctly.

The stress test description now uses the correct "MCP for Unity" terminology.

184-184: LGTM! Debug instruction updated correctly.

The reference to the Unity Editor window now uses the consistent "MCP for Unity" naming.

README.md (3)

305-305: LGTM! Telemetry section heading updated correctly.

The introduction now uses the consistent "MCP for Unity" branding.

311-311: Nice addition! Privacy statement enhances user trust.

The new privacy note complements the telemetry section well and reinforces the opt-in nature of data collection.

357-361: LGTM! Unity AI Tools section updated consistently.

All references to the tool now use "MCP for Unity" branding, including the comparison blog post link.

docs/TELEMETRY.md (4)

1-1: LGTM! Document title updated correctly.

The main heading now uses the consistent "MCP for Unity Telemetry" branding.

3-3: LGTM! Introduction updated correctly.

The opening paragraph now consistently references "MCP for Unity".

41-41: LGTM! Environment variable comment updated.

The comment now correctly identifies this as "MCP for Unity specific".

178-178: LGTM! Closing note updated correctly.

The final statement now uses the consistent "MCP for Unity" branding.

MCPForUnity/Editor/Services/IBridgeControlService.cs (3)

4-4: LGTM! Interface documentation updated correctly.

The XML summary now uses the consistent "MCP for Unity Bridge" terminology.

24-24: LGTM! Start method documentation updated correctly.

The XML summary consistently uses "MCP for Unity Bridge".

29-29: LGTM! Stop method documentation updated correctly.

The XML summary maintains consistent "MCP for Unity Bridge" branding.

MCPForUnity/UnityMcpServer~/src/unity_connection.py (3)

87-87: LGTM! Handshake log message updated correctly.

The debug log now uses the consistent "MCP for Unity" branding. No functional changes to the handshake logic.

93-95: LGTM! Error messages updated correctly.

Both the sendall advisory message and the ConnectionError now use consistent "MCP for Unity" branding. The protocol enforcement logic remains unchanged.

Note: The static analysis hint about TRY003 (long messages outside exception class) is a pre-existing code style suggestion unrelated to this branding update.

99-99: LGTM! Warning message updated correctly.

The legacy mode warning now uses the consistent "MCP for Unity" terminology.

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

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

docs: replace "Unity MCP" with "MCP for Unity" in all text strings

75c5128

msanatan self-assigned this Oct 11, 2025

msanatan merged commit 3a9ec4f into CoplayDev:main Oct 11, 2025
1 check passed

msanatan deleted the feature/fix-brand-name branch October 11, 2025 08:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: replace "Unity MCP" with "MCP for Unity" in all text strings #314

docs: replace "Unity MCP" with "MCP for Unity" in all text strings #314

Uh oh!

msanatan commented Oct 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

docs: replace "Unity MCP" with "MCP for Unity" in all text strings #314

docs: replace "Unity MCP" with "MCP for Unity" in all text strings #314

Uh oh!

Conversation

msanatan commented Oct 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

msanatan commented Oct 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 11, 2025 •

edited

Loading