Skip to content

AlexeyPerov/Unity-Open-MCP

Repository files navigation

Docs

MCP for Unity

Unity Open MCP

Unity Open MCP is a comprehensive set of tools to use AI agents with Unity projects.

The MCP server consists of a total of 229 tools:

  • Typed editor/project tools (core package): 92
  • Core + validation tools: 16
  • Asset intelligence + senses + discovery + diagnostics + meta tools: 34
  • Optional extension-pack tools: 87

Key features

  • Safe mutation workflow with automatic validation, checkpoints, deltas, regression checks, and targeted fixes.
  • Asset intelligence tools including reserialize, structured asset read/search, and reference analysis.
  • Live + fallback routing (live Unity bridge, batch mode for supported tools, offline readers where possible).
  • Typed Unity tool surface for scenes, GameObjects, components, packages, build settings, profiler controls, and project settings.
  • Bundled domain tool groups for Navigation, Input System, ProBuilder, Particle System, Animation, Splines, Lighting, Audio, UI, Constraints & LOD, Terrain, Cinemachine, Timeline, Tilemap, Shader Graph, VFX Graph, and Memory Profiler — embedded in the bridge, compiled in automatically when the matching Unity package is present (or unconditionally for built-in modules like Lighting, Audio, UI, Constraints & LOD, and Terrain; Cinemachine is reflection-gated — its assembly always compiles and detects the supported version at call time), and surfaced per session via tool groups. Shader Graph, VFX Graph, and Memory Profiler auto-activate — their tool groups appear automatically when the matching package is installed, no manual opt-in.
  • Unity Hub Pro wizard for guided setup and maintainer workflows.

For the full catalog and contracts, see docs/api/mcp-tools.md.

Typical Unity MCP issue How Unity Open MCP solves it
AI can mutate project state unsafely Gate-based workflow with validation, checkpoints, deltas, regression checks, and targeted fixes
Weak asset visibility and cross-reference context Asset intelligence tools for structured read/search, reserialize flows, and reference analysis
Tooling breaks when Unity/editor runtime is unavailable Live bridge + batch fallback + offline readers where possible
Generic tools miss Unity-specific workflows Typed tool surface for scenes, GameObjects, components, packages, build settings, profiler, and project settings
Domain workflows require custom setup Domain tools embed in the bridge, compile when the Unity package is present, and surface as per-session tool groups

Quick setup

Requires Unity 2022.3 LTS or newer.

Use any of this options:

  1. Install Unity Hub Pro and use its AI Setup wizard (simplest, no console needed): see Wizard setup.

plot

  1. If you prefer manual setup: see Manual setup.
  2. If prefer cloning this repo and working with it directly: see Development setup. Fits contributor workflow.

Domain tools (NavMesh, Input System, ProBuilder, lighting, Shader Graph, …) are embedded in the bridge — see Extensions for the catalog and activation steps.

Documentation

  • Architecture — repository boundaries and runtime flow.
  • Dialog policy — startup modal auto-dismiss and UNITY_OPEN_MCP_DIALOG_POLICY.
  • Troubleshooting — bridge start failures, zombie listeners, and connectivity recovery.
  • Skills — agent playbooks (SKILL.md) shipped into a project.
  • API index — contract documentation map.
  • Bridge HTTP API — bridge endpoints and envelopes.
  • MCP resources API — resource URIs and payloads.
  • Code conventions — non-obvious C# decisions (instance IDs, namespace aliasing).
  • Versioning — how the shared server/bridge/verify version and the Hub app version are managed, bumped, and kept in sync; the runtime compatibility check.
  • CI templates — GitHub Actions / GitLab CI templates for health checks, verify scans, and regression gates in standard CI.
  • Contributing — extensions — embedded domain gates, wiring checklist, community packs.

Would like to see other MCP options? See the MCP tools for Unity comparison — a side-by-side feature matrix of Unity Open MCP and the other MCP tools / AI assistants in the space.

Unity Hub Pro

Unity Hub Pro is the desktop companion app for Unity Open MCP. It helps you manage projects, run the AI Setup wizard, and handle maintainer workflows from one UI. See docs for details.

Contributing

  • Feel free to open issues for bugs, feature requests, and documentation improvements.
  • PRs are welcome. Start with the docs above, then package-level READMEs for local development details.

Helpful resources for contributors or those who would like to work on their own forks:

  • Validation Suite — app for guided manual validation; ships runnable scenario packs.

License: MIT — see LICENSE.

About

Unity-Open-MCP is a complete set of tools to use AI with Unity. It acts as a bridge between AI agents (like Claude Code, Cursor, ZCode) and Unity providing various tools and senses to control gameObjects, scenes, scripts etc

Topics

Resources

License

Stars

3 stars

Watchers

0 watching

Forks

Contributors