Skip to content

AlexeyPerov/Unity-Open-MCP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

409 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Unity Open MCP

Docs

๐Ÿ‡บ๐Ÿ‡ธ English ๐Ÿ‡จ๐Ÿ‡ณ ็ฎ€ไฝ“ไธญๆ–‡ ๐Ÿ‡ท๐Ÿ‡บ ะ ัƒััะบะธะน

Unity Open MCP

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.


Part of Open MCP toolset

Unity Open MCP Unreal Open MCP Godot Open MCP

Key features

Asset intelligence

Structured search, inspection, reserialization, and reference / dependency analysis โ€” including offline readers when Unity is closed.

Example: "Find all Prefabs that reference PlayerController and summarize inbound dependencies."

Live bridge, batch fallback, offline reads

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."

Typed editor + embedded domains

GameObjects, scenes, prefabs, materials, packages, plus package-gated domains (NavMesh, Input System, Cinemachine, Timeline, Shader Graph, and more).

Example: "Activate cinemachine and create a follow camera for the Player."

Agent senses and diagnostics

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."

Session tool groups and skills

Default groups stay small; activate domains on demand. Project skills teach agents the mutate โ†’ gate โ†’ fix loop.

Example: "Reset tool groups, then activate only core and gate-and-verify."

CI, baselines, and regression

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."

Unity Hub Pro

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).

Safety-gated mutations

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 for Enemyโ€ฆ
Gate: Deleting it would introduce new missing references on Level1 and SpawnPoint.
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.

Quick setup

Requires Unity 2022.3 LTS or newer.

  1. 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.

  1. Manual: edit the package and MCP client configuration yourself with Manual setup.
  2. Local checkout: build and run the repository with Development setup.
  3. Unity Hub Pro: use the UI flow in Wizard setup.

Documentation

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:

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

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

Contributing

Stars

6 stars

Watchers

0 watching

Forks

Contributors