This page mirrors the existing repository install contract. It does not replace the README; it makes the install intent indexable for search while preserving the AI-driven setup sequence.
| Step | What stays true |
|---|---|
| 1. Read docs | Start with README.md, INSTALL.md, and the matching client guide. |
| 2. Preflight | Confirm Python 3.10+, Unity project shape, target client, and whether user-level config would change. |
| 3. Plan first | Run setup-plan before any mutation. |
| 4. Review and approval | Show a short preflight review and wait for explicit approval before clone, installer runs, config edits, or setup-apply. |
| 5. Apply | Run setup-apply only for the approved project roots. |
| 6. Verify | Run validate-setup, then ensure-ready, then the first status check. |
The documented production package route remains Git UPM:
https://github.com/FoxsterDev/xuunity-mcp.git?path=/packages/com.xuunity.light-mcp#v0.3.28
Initialize the host-side helper from the repository root:
bash init_xuunity_light_unity_mcp.sh
Codex-style config for ~/.codex/config.toml plus safe review requirements.
Project and user mcp.json guidance with merge-only behavior for existing servers.
Templates and review expectations for helper reuse and explicit approval.
No. The repository documentation treats setup-plan as the non-mutating preflight step before approval.
Yes. Test operations are optional. The package works without making com.unity.test-framework a hard dependency.
Use request-status-summary if the current session cannot see new tools yet. After restart or refresh, use unity_status_summary.