Unity MCP server for AI agents

MCP for Unity is a bridge that allows AI assistants like Claude or Cursor to interact directly with your Unity Editor. Through this local Model Context Protocol (MCP) server, you can instruct LLMs to perform various Unity tasks including managing assets, controlling scenes, editing scripts, and automating workflows using natural language.

Installation Requirements

Prerequisites

Python: Version 3.12 or newer
Unity Hub & Editor: Version 2021.3 LTS or newer

uv (Python toolchain manager):

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
winget install Astral.Sh.Uv

An MCP Client: Such as Claude Desktop, Claude Code, Cursor, or others

Step 1: Install the Unity Package

To install via Git URL

Open your Unity project
Go to Window > Package Manager
Click + -> Add package from git URL...

Enter:

https://github.com/CoplayDev/unity-mcp.git?path=/UnityMcpBridge

Click Add
The MCP server is installed automatically by the package on first run or via Auto-Setup

To install via OpenUPM

Install the OpenUPM CLI
Open a terminal and navigate to your Unity project directory
Run openupm add com.coplaydev.unity-mcp

Step 2: Configure Your MCP Client

Option A: Auto-Setup (Recommended)

In Unity, go to Window > MCP for Unity
Click Auto-Setup
Look for a green status indicator 🟢 and "Connected ✓"

Option B: Manual Configuration

If Auto-Setup fails or you use a different client:

Find your MCP Client's configuration file (Check client documentation)
- Claude Example (macOS): ~/Library/Application Support/Claude/claude_desktop_config.json
- Claude Example (Windows): %APPDATA%\Claude\claude_desktop_config.json
Edit the file to add/update the mcpServers section

For Claude Code (run from your Unity project's home directory):

macOS:

claude mcp add UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py

Windows:

claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Local/Microsoft/WinGet/Links/uv.exe" --directory "C:/Users/USERNAME/AppData/Local/UnityMCP/UnityMcpServer/src" run server.py

For VSCode (all OS):

{
  "servers": {
    "unityMCP": {
      "command": "uv",
      "args": ["--directory","<ABSOLUTE_PATH_TO>/UnityMcpServer/src","run","server.py"],
      "type": "stdio"
    }
  }
}

Usage

Open your Unity Project. The MCP for Unity package should connect automatically. Check status via Window > MCP for Unity.
Start your MCP Client (Claude, Cursor, etc.). It should automatically launch the MCP for Unity Server (Python) using the configuration from Installation Step 2.
Interact! Unity tools should now be available in your MCP Client.

Example Prompts:
- "Create a 3D player controller"
- "Create a tic-tac-toe game in 3D"
- "Create a cool shader and apply to a cube"

Troubleshooting

Unity Bridge Not Running/Connecting

Ensure Unity Editor is open
Check the status window: Window > MCP for Unity
Restart Unity

MCP Client Not Connecting / Server Not Starting

Verify Server Path: Double-check the --directory path in your MCP Client's JSON config
- Windows: %USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src
- macOS: ~/Library/AppSupport/UnityMCP/UnityMcpServer\src
- Linux: ~/.local/share/UnityMCP/UnityMcpServer\src
Verify uv: Make sure uv is installed and working (uv --version)

Run Manually: Try running the server directly from the terminal:

cd /path/to/your/UnityMCP/UnityMcpServer/src
uv run server.py

Auto-Configure Failed

Use the Manual Configuration steps. Auto-configure might lack permissions to write to the MCP client's config file.

For additional help, join the Discord community at https://discord.gg/y4p8KfzrN4.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "unityMCP" '{"command":"uv","args":["--directory","/path/to/your/unity-mcp/Python","run","server.py"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "unityMCP": {
            "command": "uv",
            "args": [
                "--directory",
                "/path/to/your/unity-mcp/Python",
                "run",
                "server.py"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "unityMCP": {
            "command": "uv",
            "args": [
                "--directory",
                "/path/to/your/unity-mcp/Python",
                "run",
                "server.py"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect