Unreal Engine MCP server

The unreal-mcp server provides a Model Context Protocol (MCP) implementation for Unreal Engine that leverages the built-in Python remote execution capabilities, allowing AI tools and agents to interact with your Unreal Engine projects without requiring custom plugins.

Getting Started

Requirements

• Unreal Engine 5.4+ (may work with earlier versions)
• Node.js with npx
• MCP Client (Claude, Cursor, etc.)

Installation

Setting up Unreal Engine

1. Open your Unreal Engine project
2. Enable the Python Editor Script Plugin:
   • Go to Edit -> Plugins
   • Search for "Python Editor Script Plugin" and enable it
   • Restart the editor if prompted
3. Enable Remote Execution:
   • Go to Edit -> Project Settings
   • Search for "Python" and enable the "Enable Remote Execution" option

Configuring Your MCP Client

Edit your Claude (or Cursor) configuration file to include the unreal-mcp server:

{
  "mcpServers": {
    "unreal": {
      "command": "npx",
      "args": [
        "-y",
        "@runreal/unreal-mcp"
      ]
    }
  }
}

Troubleshooting

If you encounter an error like MCP Unreal: Unexpected token 'C', Connection..., the MCP server couldn't connect to the Unreal Editor.

Try these solutions:

• Verify the Python Editor Script Plugin is enabled
• Check that Remote Execution is enabled in project settings
• Change your bind address from 127.0.0.1 to 0.0.0.0 (note: this allows local network connections)
• Restart your Unreal Editor completely
• Close and reopen your client (Claude, Cursor, etc.)
• Check for and terminate any zombie unreal-mcp Node.js processes

Available Tools

Engine and Project Management

• set_unreal_engine_path: Set the Unreal Engine path
• set_unreal_project_path: Set the Project path
• get_unreal_engine_path: Get the current Unreal Engine path
• get_unreal_project_path: Get the current Unreal Project path

Python and Asset Management

• editor_run_python: Execute any Python code within the Unreal Editor
• editor_list_assets: List all Unreal assets
• editor_export_asset: Export an Unreal asset to text
• editor_get_asset_info: Get information about an asset (includes LOD levels for meshes)
• editor_get_asset_references: Get references for an asset
• editor_search_assets: Search for assets by name or path with optional class filter
• editor_validate_assets: Validate assets in the project to check for errors

Project and Level Operations

• editor_console_command: Run a console command in Unreal
• editor_project_info: Get detailed information about the current project
• editor_get_map_info: Get detailed information about the current map/level
• editor_get_world_outliner: Get all actors in the current world with their properties

Object Manipulation

• editor_create_object: Create a new object/actor in the world
• editor_update_object: Update an existing object/actor in the world
• editor_delete_object: Delete an object/actor from the world

Visualization

• editor_take_screenshot: Take a screenshot of the Unreal Editor
• editor_move_camera: Move the viewport camera to a specific location and rotation

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 "unreal" '{"command":"npx","args":["-y","@runreal/unreal-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": {
        "unreal": {
            "command": "npx",
            "args": [
                "-y",
                "@runreal/unreal-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": {
        "unreal": {
            "command": "npx",
            "args": [
                "-y",
                "@runreal/unreal-mcp"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect