Update install.md

[gm122921980-create]

Description

Type of Change

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update
• Refactoring (no functional changes)
• Test update

Changes Made

Compatibility / Package Source

• Unity version(s) tested:
• Package source used (#beta, #main, tag, branch, or file:):
• Resolved commit hash from Packages/packages-lock.json (if using a Git package URL):

Testing/Screenshots/Recordings

• Python tests (cd Server && uv run pytest tests/ -v)
• Unity EditMode tests
• Unity PlayMode tests
• Package import/compile check
• Not applicable (explain why in Additional Notes)

Documentation Updates

• I have added/removed/modified tools or resources
• If yes, I have updated all documentation files using:
  • The LLM prompt at tools/UPDATE_DOCS_PROMPT.md (recommended)
  • Manual review of the generated changes

Related Issues

Additional Notes

Summary by CodeRabbit

• Documentation
  • Added comprehensive installation guide covering three setup methods (Git URL, Unity Asset Store, OpenUPM), MCP server initialization and client connection procedures with detailed configuration examples for both HTTP and stdio protocols (including platform-specific command variants), plus basic troubleshooting guidance.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new documentation page website/docs/getting-started/install.md was added. It covers three Unity package installation methods (Git URL, Unity Asset Store, OpenUPM), instructions for starting the MCP server and connecting an MCP client, manual HTTP and stdio configuration examples (with macOS/Linux and Windows variants), and basic troubleshooting guidance.

Changes

Cohort / File(s)	Summary
Install Documentation website/docs/getting-started/install.md	New page added documenting Unity package installation via Git URL, Asset Store, and OpenUPM; MCP server startup; HTTP and stdio client configuration with OS-specific command variants; and troubleshooting notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• CoplayDev/unity-mcp#265: Covers overlapping content — Unity MCP package setup and MCP client configuration (HTTP/stdio, OS-specific snippets) in the README, which mirrors what the new install page documents.

Poem

🐇 Hippity-hop, a new page appears,
With Git URLs and stdio gears!
Install via OpenUPM with ease,
Connect your MCP client, if you please.
From macOS paths to Windows too,
The docs are fresh, the setup's through! ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is entirely templated with no substantive content. All sections remain unchecked or blank despite significant documentation changes being made.	Fill in all required sections with actual details: describe what was changed in install.md, specify Unity versions tested, explain the rationale, and provide any relevant context or related issues.
Title check	❓ Inconclusive	The title is vague and overly generic, using only 'Update install.md' without conveying meaningful information about what specific content was changed or why.	Provide a more descriptive title that highlights the main change, such as 'Add installation instructions and troubleshooting guide' or 'Document multiple installation methods for Unity package'.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with 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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[gm122921980-create]

---

< Looking for trouble in all the right places. >

\
(__/)
(•ㅅ•)
/ づ