| ๐บ๐ธ English | ๐จ๐ณ ็ฎไฝไธญๆ | ๐ท๐บ ะ ัััะบะธะน |
|---|
Unity Open MCP gives AI agents a typed, safety-gated tool surface for Unity projects.
The MCP server exposes 250+ tools across typed editor workflows, gate and validation, asset intelligence, diagnostics, and embedded domain groups.
Structured search, inspection, reserialization, and reference / dependency analysis โ including offline readers when Unity is closed.
Example: "Find all Prefabs that reference
PlayerControllerand summarize inbound dependencies."
Prefer the live Editor; fall back to headless batch for supported tools; read assets and compile errors from disk when needed.
Example: "Bridge is offline โ show me the latest compile errors from the Editor log."
GameObjects, scenes, prefabs, materials, packages, plus package-gated domains (NavMesh, Input System, Cinemachine, Timeline, Shader Graph, and more).
Example: "Activate
cinemachineand create a follow camera for the Player."
Test runner, screenshots, console, profiler / memory snapshots, and event pull for closed-loop agent workflows.
Example: "Run Play Mode tests for the Combat assembly and capture a Game-view screenshot on failure."
Default groups stay small; activate domains on demand. Project skills teach agents the mutate โ gate โ fix loop.
Example: "Reset tool groups, then activate only
coreandgate-and-verify."
Scan projects, create verify baselines, and fail automation when new blocking issues appear โ live or via batch/CLI.
Example: "Create a verify baseline for this project, then report any new blocking issues since the last baseline."
Optional desktop app for project management, AI Setup wizard, and maintainer actions โ not required for the MCP path.
Example: use the Hub AI action on a project row (see Unity Hub Pro).
Mutations run checkpoint โ mutate โ validate โ delta, with regression checks
and targeted fixes โ so agents can stop before a โsuccessfulโ edit leaves the
project broken.
User: Remove that prefab.
Agent: Checking impact forEnemyโฆ
Gate: Deleting it would introduce new missing references onLevel1andSpawnPoint.
Agent: Unity Open MCP flagged that regression in the gate preview. I am not removing the prefab without your confirmation โ those scenes would break. Want me to delete it and then fix the references, or leave it?
More example prompts: docs/api/mcp-tools.md. Full catalog and contracts: docs/api/mcp-tools.md.
Requires Unity 2022.3 LTS or newer.
- Easiest (AI agent): paste this prompt into your AI client (Cursor, Claude, โฆ) and let it install for you:
Install Unity Open MCP in this Unity project by following
https://raw.githubusercontent.com/AlexeyPerov/Unity-Open-MCP/master/docs/setup/agent-setup.md
exactly. Do every agent step yourself; stop and tell me only when a human action is required.
If this monorepo is already open locally, read docs/setup/agent-setup.md from disk instead of fetching.
Full procedure: Agent setup.
- Manual: edit the package and MCP client configuration yourself with Manual setup.
- Local checkout: build and run the repository with Development setup.
- Unity Hub Pro: use the UI flow in Wizard setup.
For users:
- API index โ MCP, bridge, resource, routing, and automation contracts.
- Extensions โ embedded domains, dependencies, and tool-group activation.
- Troubleshooting โ connectivity and recovery guidance.
- Dialog policy โ startup modal handling and automation.
- Skills โ agent playbooks installed into Unity projects.
- Version compatibility โ version matching and mismatch recovery.
For contributors:
- Architecture โ repository boundaries and runtime flow.
- Code conventions โ non-obvious C# contracts.
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 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.
- Read CONTRIBUTING.md before opening an issue or pull request.
- Contributor troubleshooting covers local test, bridge, and automation failures.
- Validation Suite โ app for guided manual validation; ships runnable scenario packs.
- Maintainer versioning and releases โ synchronization, tags, and release workflows.
License: MIT โ see LICENSE.