Unity Editor

by igordias2

Not rated
GitHub

About

Integrates with Unity Editor to provide real-time access to scene hierarchies, project structures, and GameObject manipulation for AI-assisted game development workflows.

Details

Author
igordias2
Repository
igordias2/UnityMCP
License
Other
Categories
Productivity, Developer Tools, AI, Infrastructure
Tags
#integration

- Command execution timeout protection
- Error handling and validation
- Log buffer management
- Connection state monitoring

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Unity Editor
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 -y
    • Argument 2 @highlight/mcp-server

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

To install UnityMCP for Claude Desktop automatically via Smithery:

``bash
npx -y @smithery/cli install @Arodoid/unitymcp --client claude


1. Copy the
UnityMCPPlugin folder to your Unity project's Assets directory
2. Open Unity Editor
3. Access the plugin through Unity's top menu bar > UnityMCP > Debug Window

bash
cd unity-mcp-server
npm install
npm run build
``

get_editor_state

Retrieves the current Unity Editor state, including active GameObjects, selection state, play mode status, scene hierarchy, and project structure. Supports different output formats (Raw, scripts only, no scripts).

execute_editor_command

Executes C# code directly in the Unity Editor with full access to UnityEngine and UnityEditor APIs. Provides real-time execution and comprehensive error handling, along with command timeout protection.

get_logs

Retrieves and filters Unity Editor logs, allowing for filtering by type, content, and timestamp. Customizable output fields and buffer management for optimal performance are supported.

1. get_editor_state
- Retrieves current Unity Editor state
- Includes active GameObjects, selection state, play mode status
- Provides scene hierarchy and project structure
- Supports different output formats (Raw, scripts only, no scripts)

2. execute_editor_command
- Executes C# code directly in the Unity Editor
- Full access to UnityEngine and UnityEditor APIs
- Real-time execution with comprehensive error handling
- Command timeout protection

3. get_logs
- Retrieves and filters Unity Editor logs
- Supports filtering by type, content, and timestamp
- Customizable output fields
- Buffer management for optimal performance

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "unity editor": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Macos

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Windows

{
    "env": [],
    "args": [
        "/c",
        "npx",
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "cmd"
}

2. MCP Server (unity-mcp-server)

A TypeScript-based MCP server that exposes Unity Editor functionality through standardized tools:

Available Tools

1. get_editor_state - Retrieves current Unity Editor state - Includes active GameObjects, selection state, play mode status - Provides scene hierarchy and project structure - Supports different output formats (Raw, scripts only, no scripts) 2. execute_editor_command - Executes C# code directly in the Unity Editor - Full access to UnityEngine and UnityEditor APIs - Real-time execution with comprehensive error handling - Command timeout protection 3. get_logs - Retrieves and filters Unity Editor logs - Supports filtering by type, content, and timestamp - Customizable output fields - Buffer management for optimal performance
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.