Unity MCP ✨

Connect your Unity Editor to LLMs using the Model Context Protocol.

Unity MCP acts as a bridge, allowing AI assistants (like Claude, Cursor) to interact directly with your Unity Editor via a local MCP (Model Context Protocol) Client. Give your LLM tools to manage assets, control scenes, edit scripts, and automate tasks within Unity.

Key Features 🚀

• 🗣️ Natural Language Control: Instruct your LLM to perform Unity tasks.
• 🛠️ Powerful Tools: Manage assets, scenes, materials, scripts, and editor functions.
• 🤖 Automation: Automate repetitive Unity workflows.
• 🧩 Extensible: Designed to work with various MCP Clients.

How It Works 🤔

Unity MCP connects your tools using two components:

1. Unity MCP Bridge: A Unity package running inside the Editor. (Installed via Package Manager).
2. Unity MCP Server: A Python server that runs locally, communicating between the Unity Bridge and your MCP Client. (Installed manually).

Flow: [Your LLM via MCP Client] <-> [Unity MCP Server (Python)] <-> [Unity MCP Bridge (Unity Editor)]

Installation ⚙️

Note: The setup is constantly improving as we update the package. Check back if you randomly start to run into issues.

Prerequisites

Step 1: Install the Unity Package (Bridge)

1. Open your Unity project.
2. Go to Window > Package Manager.
3. Click + -> Add package from git URL....
4. Enter:

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

5. Click Add.
6. The MCP Server should automatically be installed onto your machine as a result of this process.

Step 2: Configure Your MCP Client

Connect your MCP Client (Claude, Cursor, etc.) to the Python server you installed in Step 1.

Option A: Auto-Configure (Recommended for Claude/Cursor)

1. In Unity, go to Window > Unity MCP.
2. Click Auto Configure Claude or Auto Configure Cursor.
3. Look for a green status indicator 🟢 and "Connected". (This attempts to modify the MCP Client's config file automatically).

Option B: Manual Configuration

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

1. 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
2. Edit the file to add/update the mcpServers section, using the exact paths from Step 1.

{
  "mcpServers": {
    "UnityMCP": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Programs\\UnityMCP\\UnityMcpServer\\src",
        "server.py"
      ]
    }
    // ... other servers might be here ...
  }
}

{
  "mcpServers": {
    "UnityMCP": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/usr/local/bin/UnityMCP/UnityMcpServer/src",
        "server.py"
      ]
    }
    // ... other servers might be here ...
  }
}

{
  "mcpServers": {
    "UnityMCP": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/home/YOUR_USERNAME/bin/UnityMCP/UnityMcpServer/src",
        "server.py"
      ]
    }
    // ... other servers might be here ...
  }
}

Usage ▶️

1. Open your Unity Project. The Unity MCP Bridge (package) should connect automatically. Check status via Window > Unity MCP.

2. Start your MCP Client (Claude, Cursor, etc.). It should automatically launch the Unity MCP Server (Python) using the configuration from Installation Step 3.

3. Interact! Unity tools should now be available in your MCP Client.

   Example Prompt: Create a 3D player controller.

Contributing 🤝

Help make Unity MCP better!

1. Fork the main repository.

2. Create a branch (feature/your-idea or bugfix/your-fix).

3. Make changes.

4. Commit (feat: Add cool new feature).

5. Push your branch.

6. Open a Pull Request against the master branch.

Troubleshooting ❓

Still stuck? Open an Issue.

License 📜

MIT License. See LICENSE file.

Contact 👋

• X/Twitter: @justinpbarnett

Acknowledgments 🙏

Thanks to the contributors and the Unity team.