unreal-mcp

unreal-mcp

3.5

If you are the rightful owner of unreal-mcp and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The Unreal-MCP is a server for Unreal Engine that leverages the built-in Python remote execution protocol, allowing for seamless integration and control over the Unreal Editor without the need for additional plugins.

unreal-mcp

MCP server for Unreal Engine that uses Unreal Python Remote Execution

Twitter · Discord

⚡ Differences

This server does not require installing a new UE plugin as it uses the built-in Python remote execution protocol.

Adding new tools/features is much faster to develop since it does not require any C++ code.

It can support the full Unreal Engine Python API

⚠️ Note

  • This is not an official Unreal Engine project.
  • Your AI agents or tools will have full access to your Editor.
  • Review any changes your Client suggests before you approve them.

📦 Installation

📋 Requirements
  • 🔧 Unreal Engine 5.4+ (verified, may work with earlier versions)
  • 🟢 Node.js with npx
  • 🤖 MCP Client (Claude, Cursor, etc.)
  1. Setting up your Editor:
    • Open your Unreal Engine project
    • Go to Edit -> Plugins
    • Search for "Python Editor Script Plugin" and enable it
    • Restart the editor if prompted
    • Go to Edit -> Project Settings
    • Search for "Python" and enable the "Enable Remote Execution" option

  1. Set up your Client:
    • Edit your Claude (or Cursor) config
{
  "mcpServers": {
    "unreal": {
      "command": "npx",
      "args": [
        "-y",
        "@runreal/unreal-mcp"
      ]
    }
  }
}

🔧 Troubleshooting

If you get an error similar to MCP Unreal: Unexpected token 'C', Connection... it means that the mcp-server was not able to connect to the Unreal Editor.

  • Make sure that the Python Editor Script Plugin is enabled and that the Remote Execution option is checked in your project settings.
  • Try also changing your bind address from 127.0.0.1 to 0.0.0.0 but note that this will allow connections from your local network.
  • Restart your Unreal Editor fully.
  • Fully close/open your client (Claude, Cursor, etc.) to ensure it reconnects to the MCP server. (File -> Exit on windows).
  • Check your running processes and kill any zombie unreal-mcp Node.js processes.

🛠️ Available Tools

ToolDescription
set_unreal_engine_pathSet the Unreal Engine path
set_unreal_project_pathSet the Project path
get_unreal_engine_pathGet the current Unreal Engine path
get_unreal_project_pathGet the current Unreal Project path
editor_run_pythonExecute any python within the Unreal Editor
editor_list_assetsList all Unreal assets
editor_export_assetExport an Unreal asset to text
editor_get_asset_infoGet information about an asset, including LOD levels for StaticMesh and SkeletalMesh assets
editor_get_asset_referencesGet references for an asset
editor_console_commandRun a console command in Unreal
editor_project_infoGet detailed information about the current project
editor_get_map_infoGet detailed information about the current map/level
editor_search_assetsSearch for assets by name or path with optional class filter
editor_get_world_outlinerGet all actors in the current world with their properties
editor_validate_assetsValidate assets in the project to check for errors
editor_create_objectCreate a new object/actor in the world
editor_update_objectUpdate an existing object/actor in the world
editor_delete_objectDelete an object/actor from the world
editor_take_screenshotTake a screenshot of the Unreal Editor
editor_move_cameraMove the viewport camera to a specific location and rotation for positioning screenshots

🤝 Contributing

Please feel free to open issues or pull requests. Contributions are welcome, especially new tools/commands.

License MIT