XUUnity MCP
Safe install path

Install XUUnity MCP without breaking the AI setup flow

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.

Canonical install flow

Step What stays true
1. Read docsStart with README.md, INSTALL.md, and the matching client guide.
2. PreflightConfirm Python 3.10+, Unity project shape, target client, and whether user-level config would change.
3. Plan firstRun setup-plan before any mutation.
4. Review and approvalShow a short preflight review and wait for explicit approval before clone, installer runs, config edits, or setup-apply.
5. ApplyRun setup-apply only for the approved project roots.
6. VerifyRun validate-setup, then ensure-ready, then the first status check.

Exact install command

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

Client-specific install references

Codex

Codex-style config for ~/.codex/config.toml plus safe review requirements.

Cursor

Project and user mcp.json guidance with merge-only behavior for existing servers.

Claude Code / Desktop

Templates and review expectations for helper reuse and explicit approval.

Install FAQ

Can I skip setup-plan if I already know my project?

No. The repository documentation treats setup-plan as the non-mutating preflight step before approval.

Can I install the package without Test Framework?

Yes. Test operations are optional. The package works without making com.unity.test-framework a hard dependency.

What is the first live MCP smoke check after install?

Use request-status-summary if the current session cannot see new tools yet. After restart or refresh, use unity_status_summary.