UE-MCP

Provides a FastMCP-based server to run Python in Unreal Editor and control Unreal projects remotely.

python

0

GitHub Stars

python

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "chengdagong-ue-mcp": {
      "command": "ue-mcp",
      "args": []
    }
  }
}

UE-MCP provides a FastMCP-based server that lets an AI assistant run Python code inside Unreal Editor, enabling automated editor workflows, remote scripting, and project-controlled automation with safe, isolated editor instances.

How to use

You connect to the UE-MCP server from an MCP client to run Python code inside Unreal Editor. The server is bound to a single Unreal Engine 5 project, relaunches the editor as needed, and handles remote execution through a socket-based protocol. You can start the server from your UE5 project directory and then issue commands to launch the editor, execute Python code, check status, or build the project.

How to install

Prerequisites you need before installing: Python 3.10 or newer, Unreal Engine 5.x with the Python plugin, and FastMCP version 2.0.0 or newer.

pip install -e .

Navigate to your Unreal Engine 5 project directory and install the MCP server in editable mode so you can run it against your project.

cd /path/to/your/ue5/project
ue-mcp

Alternatively, you can run the server through FastMCP, which lets you start the MCP via a generalized runner.

fastmcp run ue_mcp.server:mcp

Configuration and usage notes

The server automatically configures the Python plugin and remote execution settings for you. It also ensures that a dedicated editor process is managed and cleaned up on exit, and it isolates each MCP server instance to a single UE5 project.

Available tools

editor.launch

Launch Unreal Editor with the Python plugin enabled. This call starts the editor and waits for it to become ready before returning.

editor.status

Return the current status of the Unreal Editor, including whether it is running and ready for Python execution.

editor.stop

Stop the running Unreal Editor process managed by the MCP server.

editor.execute

Execute arbitrary Python code inside the Unreal Editor context, enabling automation and editor scripting.

editor.configure

Check and fix project configuration to ensure the Python remote execution environment is correctly set up.

project.build

Build the UE5 project using UnrealBuildTool with specified target, configuration, and platform.