Unity MCP server

The Unity MCP Server acts as a bridge between your Unity project and AI language models, enabling AI-assisted game development through natural language commands. It implements the Model Context Protocol (MCP) to provide tools and resources that an AI can use to interact with Unity.

Installation

To start using the Unity MCP Server, you'll need to:

1. Install the Unity MCP Plugin
2. Install an MCP Client (like Claude Code)
3. Configure the connection between them

Setting Up the MCP Server

You can run the MCP Server in several ways:

Docker Container

docker run -p 8080:8080 ivanmurzakdev/unity-mcp-server

For STDIO transport:

docker run -t -e UNITY_MCP_CLIENT_TRANSPORT=stdio -p 8080:8080 ivanmurzakdev/unity-mcp-server

Binary Executable

Download the appropriate binary for your system from the GitHub releases page and run:

./unity-mcp-server --port 8080 --plugin-timeout 10000 --client-transport stdio

Configuration Options

The server supports these configuration variables:

Environment Variable	Command Line Arg	Description
UNITY_MCP_PORT	--port	Connection port (default: 8080)
UNITY_MCP_PLUGIN_TIMEOUT	--plugin-timeout	Connection timeout in ms (default: 10000)
UNITY_MCP_CLIENT_TRANSPORT	--client-transport	Transport type: stdio or http (default: http)

Connecting to MCP Clients

HTTP Transport Configuration

For HTTP transport, configure your MCP client with:

{
  "mcpServers": {
    "Unity-MCP": {
      "url": "http://localhost:8080"
    }
  }
}

STDIO Transport Configuration

For STDIO transport, your MCP client needs to launch the server:

{
  "mcpServers": {
    "Unity-MCP": {
      "command": "docker",
      "args": [
        "run",
        "-t",
        "-e",
        "UNITY_MCP_CLIENT_TRANSPORT=stdio",
        "-p",
        "8080:8080",
        "ivanmurzakdev/unity-mcp-server"
      ]
    }
  }
}

Using the Server

Once connected, you can communicate with the AI in natural language through your MCP client. The AI can then:

• Read and modify Unity scripts
• Create and manipulate GameObjects
• Work with materials, textures, and other assets
• Debug issues in your project
• Execute custom tools you define

Example Commands

Create 3 cubes in a circle with radius 2

Explain my scene hierarchy

Create metallic golden material and attach it to a sphere gameObject

Creating Custom MCP Tools

You can extend the server's capabilities by defining custom tools in your Unity project:

[McpPluginToolType]
public class Tool_GameObject
{
    [McpPluginTool
    (
        "MyCustomTask",
        Title = "Create a new GameObject"
    )]
    [Description("Creates a new GameObject with specified parameters.")]
    public string CustomTask
    (
        [Description("Name for the new GameObject.")]
        string inputData
    )
    {
        return MainThread.Instance.Run(() =>
        {
            // Unity API code here
            return "[Success] Operation completed.";
        });
    }
}

With this setup, your AI assistant will be able to help you develop your Unity games and applications through natural language interaction.

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 "unity-mcp" '{"command":"dotnet","args":["run","--project","path/to/unity-mcp"]}'

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": {
        "unity-mcp": {
            "command": "dotnet",
            "args": [
                "run",
                "--project",
                "path/to/unity-mcp"
            ]
        }
    }
}

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": {
        "unity-mcp": {
            "command": "dotnet",
            "args": [
                "run",
                "--project",
                "path/to/unity-mcp"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect