Skip to content

AlexeyPerov/Unity-Open-MCP

Repository files navigation

Docs

MCP for Unity

Unity Open MCP

Unity Open MCP connects AI agents to Unity projects with a bridge + gate workflow: make changes, run validation, inspect results, and iterate safely.

Requires Unity 2022.3 LTS or newer.

The MCP server consists of a total of 191 tools.

Current tool surface from mcp-server/src/tools/index.ts:

  • Core + gate + validation tools: 16
  • Asset intelligence + senses + discovery + diagnostics + meta tools: 23
  • Typed editor/project tools (core package): 97
  • Optional extension-pack tools: 55

Quick setup

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.

Optional: install extension packs for domain-specific workflows: Extensions.

Key features

  • Safe mutation workflow with gate 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, and Terrain — 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), and surfaced per session via tool groups.
  • Unity Hub Pro wizard for guided setup and maintainer workflows.

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

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.

Documentation

  • Architecture — repository boundaries and runtime flow.
  • 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.

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

Watchers

Forks

Contributors