unity-mcp/README.md

Unity MCP ✨

Create your Unity apps with LLMs!

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.

Expand for Available Tools...

Your LLM can use functions like:

• read_console: Gets messages from or clears the console.
• manage_script: Manages C# scripts (create, read, update, delete).
• manage_editor: Controls and queries the editor's state and settings.
• manage_scene: Manages scenes (load, save, create, get hierarchy, etc.).
• manage_asset: Performs asset operations (import, create, modify, delete, etc.).
• manage_shader: Performs shader CRUD operations (create, read, modify, delete).
• manage_gameobject: Manages GameObjects: create, modify, delete, find, and component operations.
• execute_menu_item: Executes a menu item via its path (e.g., "File/Save Project").

---

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

• Git CLI: For cloning the server code. Download Git
• Python: Version 3.12 or newer. Download Python
• Unity Hub & Editor: Version 2020.3 LTS or newer. Download Unity
• uv (Python package manager):

  pip install uv
  # Or see: https://docs.astral.sh/uv/getting-started/installation/
  

• An MCP Client:
  • Claude Desktop
  • Cursor
  • Visual Studio Code Copilot
  • (Others may work with manual config)

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/VSC Copilot)

1. In Unity, go to Window > Unity MCP.
2. Click Auto Configure on the IDE you uses.
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.

Click for OS-Specific JSON Configuration Snippets...

Windows:

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

(Remember to replace YOUR_USERNAME and use double backslashes \)

macOS:

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

(Replace YOUR_USERNAME if using ~/bin)

Linux:

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

(Replace YOUR_USERNAME)

---

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.

---

TODOs (Besides PR) 📝

High Priority

• AssetsGeneration Improvements - Better server request handling
• CodeGeneration Improvements - Better generated code handling
• Error Handling Improvements - Better error messages and recovery mechanisms
• Remote Connection - Enable remote connection between host and server
• Documentation Expansion - Add tutorials on how to add your own tools, and documentation on existing tools and functions

Medium Priority

• Custom Tool Creation - GUI for users to create their own MCP tools
• Logging System - Comprehensive logging for debugging and monitoring

Low Priority

• Mobile Platform Support - Extended tools for mobile development workflows
• Easier Setup

Research & Exploration

• AI-Powered Asset Generation - Integration with AI tools for automatic asset creation
• Real-time Collaboration - Live editing sessions between multiple developers (Currently ongoing)
• Analytics Dashboard - Usage analytics and project insights

---

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 ❓

Click to view common issues and fixes...

• Unity Bridge Not Running/Connecting:

  • Ensure Unity Editor is open.

  • Check the status window: Window > Unity MCP.

  • Restart Unity.

• MCP Client Not Connecting / Server Not Starting:

  • Verify Server Path: Double-check the --directory path in your MCP Client's JSON config. It must exactly match the location where you cloned the UnityMCP repository in Installation Step 1 (e.g., .../Programs/UnityMCP/UnityMcpServer/src).

  • Verify uv: Make sure uv is installed and working (pip show uv).

  • Run Manually: Try running the server directly from the terminal to see errors: # Navigate to the src directory first! cd /path/to/your/UnityMCP/UnityMcpServer/src uv run server.py

  • Permissions (macOS/Linux): If you installed the server in a system location like /usr/local/bin, ensure the user running the MCP client has permission to execute uv and access files there. Installing in ~/bin might be easier.

• Auto-Configure Failed:

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

Still stuck? Open an Issue or Join the Discord!

---

License 📜

MIT License. See LICENSE file.

---

Contact 👋

• justinpbarnett: X/Twitter
• scriptwonder: Email, LinkedIn

---

Acknowledgments 🙏

Thanks to the contributors and the Unity team.

Star History