Update the manual commands #638
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates documentation to reflect the new uvx-based command for running the MCP for Unity server, replacing legacy direct uv/uv.exe invocations and clarifying when local server folders are needed. Flow diagram for platform-specific uvx stdio configurationflowchart TD
A["Need manual MCP for Unity setup"] --> B["Determine platform"]
B --> C["macOS or Linux"]
B --> D["Windows"]
C --> E["Set mcpServers.unityMCP.command to uvx"]
C --> F["Set mcpServers.unityMCP.args to [--from, mcpforunityserver, mcp-for-unity, --transport, stdio]"]
D --> G["Set mcpServers.unityMCP.command to C:/Users/YOUR_USERNAME/AppData/Local/Microsoft/WinGet/Links/uvx.exe"]
D --> H["Set mcpServers.unityMCP.args to [--from, mcpforunityserver, mcp-for-unity, --transport, stdio]"]
E --> I["Save MCP client config"]
F --> I
G --> I
H --> I
I --> J["Optionally run uvx command manually to verify server"]
J --> K["Restart MCP client and check connection"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThe changes update documentation across multiple files to shift the MCP server invocation from using Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Poem
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. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the updated stdio examples, macOS/Linux now use bare
uvxwhile Windows uses a hardcoded WinGet path; consider adding a brief note that the Windows path may differ if uvx is installed another way and that users can calluvxdirectly if it’s on PATH to avoid confusion. - The description for “Select server folder…” now mentions the local
Serverfolder but doesn’t specify a concrete path or example; adding a short example path (e.g., relative to the project) would make it clearer for developers where this folder typically lives.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the updated stdio examples, macOS/Linux now use bare `uvx` while Windows uses a hardcoded WinGet path; consider adding a brief note that the Windows path may differ if uvx is installed another way and that users can call `uvx` directly if it’s on PATH to avoid confusion.
- The description for “Select server folder…” now mentions the local `Server` folder but doesn’t specify a concrete path or example; adding a short example path (e.g., relative to the project) would make it clearer for developers where this folder typically lives.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the manual MCP server configuration commands from the legacy uv run --directory approach to the modern uvx --from mcpforunityserver mcp-for-unity approach across all documentation files.
Changes:
- Updated stdio configuration examples from
uvtouvxwith package-based installation - Changed section label from "Stdio configuration (legacy)" to "Stdio configuration (uvx)"
- Clarified that the "Select server folder" option is for development only when using uvx
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updated stdio configuration examples to use uvx with package-based installation for macOS/Linux and Windows |
| docs/i18n/README-zh.md | Updated Chinese translation of stdio configuration examples to match README.md changes |
| docs/guides/CURSOR_HELP.md | Updated Windows troubleshooting examples to use uvx command syntax |
| MCPForUnity/README.md | Clarified that server folder selection is dev-only and usually not needed with uvx |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Type of Change
Save your change type
Changes Made
Testing/Screenshots/Recordings
Documentation Updates
tools/UPDATE_DOCS_PROMPT.md(recommended)tools/UPDATE_DOCS.mdRelated Issues
Additional Notes
Summary by Sourcery
Update MCP for Unity documentation to use the new uvx-based server invocation instead of legacy uv commands.
Documentation:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.