Unreal_mcp

This MCP server enables AI assistants to control Unreal Engine through the native C++ Automation Bridge plugin. Built with TypeScript and C++, it exposes a broad set of capabilities for asset management, actor control, editor operations, level handling, animation, physics, visual effects, sequencer, graph editing, audio, and system commands. You can orchestrate Unreal workflows by issuing MCP tool actions to remotely spawn actors, manage assets, control the editor, manipulate levels, run PIE sessions, capture screenshots, adjust cameras, and query/modify numerous Unreal systems. The server relies on the MCP Automation Bridge inside Unreal to route commands, and it supports runtime discovery of objects, safe command execution, and per-IP rate limiting for the metrics endpoint. To connect your client, configure an MCP server entry pointing to the installed server (for example via NPX usage or a built binary) and provide the Unreal project path and automation port as environment variables.

Prerequisites:

• Node.js 18+ installed on your machine
• Unreal Engine 5.0–5.7 installed and a project ready for automation

Installation steps:

1. Install the MCP server locally (NPX option is recommended):

# Option A: NPX (Recommended)
npx unreal-engine-mcp-server

2. Alternatively, clone and build from source:

git clone https://github.com/ChiR24/Unreal_mcp.git
cd Unreal_mcp
npm install
npm run build
node dist/cli.js

3. Prepare the Unreal Engine plugin (MCP Automation Bridge) inside your Unreal project as described in the repository:

• Copy or install the plugin from Unreal_mcp/plugins/McpAutomationBridge into YourUnrealProject/Plugins/McpAutomationBridge
• Enable required plugins in Unreal Editor (MCP Automation Bridge, Editor Scripting Utilities, Niagara)

4. Configure the MCP client by adding an MCP server entry, either using NPX or a built path (see the example configurations in the README):

{
  "mcpServers": {
    "unreal-engine": {
      "command": "node",
      "args": ["path/to/Unreal_mcp/dist/cli.js"],
      "env": {
        "UE_PROJECT_PATH": "C:/Path/To/YourProject",
        "MCP_AUTOMATION_PORT": "8091"
      }
    }
  }
}

5. Start the MCP server and connect your MCP client to the configured server.

Environment variables:

• UE_PROJECT_PATH is required for the server/client to locate your Unreal project.
• MCP_AUTOMATION_HOST and MCP_AUTOMATION_PORT control where the Automation Bridge listens. By default, the bridge binds to 127.0.0.1:8091 for security.

LAN Access: If you enable non-loopback access, ensure you understand the security implications and restrict access with firewalls. See the configuration guidance in the README for enabling non-loopback and setting Listen Host to 0.0.0.0.

Common issues:

• If the Unreal plugin fails to load after the first project open, simply reopen the project or rebuild the plugin from source.
• Ensure required plugins are enabled in Unreal Editor before starting automation.
• Make sure your Node/NPX version matches the documented prerequisites (Node.js 18+).

Monitoring:

• Use the MCP metrics endpoint to monitor request rates and health, and adjust LOG_LEVEL as needed for debugging.