Unreal Engine Remote Execution MCP server

This MCP Unreal Server allows you to interact with Unreal Engine instances through remote Python execution, featuring automatic discovery of Unreal nodes and the ability to execute Python code directly in Unreal Engine environments.

Features

• Unreal Instance Management

  • Automatic discovery of Unreal nodes via multicast
  • Real-time node status monitoring
  • Resource listing through LSP-compatible clients

• Remote Execution

  • Execute Python code in Unreal Engine environments
  • Support for both attended and unattended execution modes
  • File execution and statement evaluation modes

• Logging & Monitoring

  • Detailed logging to file (mcp_unreal.log)
  • Console logging with different verbosity levels
  • Node connection health monitoring

Installation

To install the MCP Unreal Server:

# Clone repository
git clone https://github.com/your-org/mcp-unreal-server.git
cd mcp-unreal-server

# Install dependencies
pip install -r requirements.txt

Configuration

Network Settings

Configure multicast parameters in RemoteExecutionConfig:

# Default multicast settings (modify in server.py)
config.multicast_group_endpoint = ("239.0.0.1", 6766)

Logging

Modify logging configuration in server.py:

# Adjust log levels
file_handler.setLevel(logging.DEBUG)  # File logging
console_handler.setLevel(logging.INFO)  # Console logging

Usage

Starting the Server

Start the MCP Unreal Server with the following command:

python -m src.mcp_server_unreal.server

Supported Tools

Connect to Unreal Instance

{
  "host": "239.0.0.1",
  "port": 6766
}

Execute Python Code

{
  "node_id": "<unreal-node-id>",
  "code": "print('Hello Unreal')",
  "unattended": true
}

API Documentation

Resource Format

types.Resource(
    uri="unreal://<node_id>",
    name=f"Unreal Instance: {node_id}",
    description="Unreal Engine instance",
    mimeType="application/x-unreal"
)

Execution Modes

• MODE_EXEC_FILE: Execute Python file
• MODE_EXEC_STATEMENT: Execute Python statement
• MODE_EVAL_STATEMENT: Evaluate Python expression

Troubleshooting

Common issues and solutions:

• No nodes discovered: Verify Unreal instances are running with MCP plugin
• Execution timeout: Check firewall settings for multicast traffic
• Connection drops: Monitor mcp_unreal.log for node status changes

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-remote-execution" '{"command":"python","args":["-m","src.mcp_server_unreal.server"]}'

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-remote-execution": {
            "command": "python",
            "args": [
                "-m",
                "src.mcp_server_unreal.server"
            ]
        }
    }
}

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-remote-execution": {
            "command": "python",
            "args": [
                "-m",
                "src.mcp_server_unreal.server"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect