📌Overview

Purpose: The Unity MCP Package aims to facilitate seamless communication between Unity and Large Language Models (LLMs) to automate workflows and enhance project capabilities.

Overview: The Unity MCP Server establishes a bidirectional communication channel between Unity and a Python server, enabling developers to programmatically manage assets, scenes, materials, and scripts within Unity, thus streamlining the development process.

Key Features:

• Bidirectional Communication: Enables effortless data exchange between Unity and LLMs, enhancing interactivity.

• Asset Management: Allows for the programmatic creation, importing, and manipulation of Unity assets, improving efficiency in project management.

• Scene Control: Provides tools for managing scenes and game objects, simplifying complex scene setups and changes.

• Material Editing: Facilitates easy modification of materials and their properties, allowing for quick visual adjustments.

• Script Integration: Supports viewing, creating, and updating C# scripts directly within Unity, promoting a streamlined coding experience.

• Editor Automation: Automates various Unity Editor functions, reducing repetitive tasks like building projects or testing environments.

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. Enable 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 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"
      ]
    }
  }
}

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

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

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 configured setup.
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 (e.g., feat: Add cool new feature).
5. Push your branch.
6. Open a Pull Request against the master branch.

Troubleshooting ❓

Still stuck? Open an Issue in the project repository.

License 📜

MIT License. See LICENSE file.

Contact 👋

• X/Twitter: @justinpbarnett

Acknowledgments 🙏

Thanks to the contributors and the Unity team.