UE5 MCP Server
Allows AI agents to interact with a live Unreal Engine 5 editor session, including inspecting and modifying scene objects, reading output logs, searching C++ source files, triggering console commands, and scaffolding new C++ classes.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@UE5 MCP Server run console command stat unit"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
UE5 MCP Server
A Model Context Protocol server that bridges Claude AI to a live Unreal Engine 5 editor session. Claude can inspect and modify scene objects, read output logs, search C++ source files, trigger console commands, and scaffold new C++ classes — all from a natural language prompt.
How It Works
Claude ──JSON-RPC──► MCP Server (Node.js) ──HTTP──► UE5 Remote Control API (port 30010)
│
└──filesystem──► Source/*.cpp/h, Saved/Logs/*.logClaude Desktop spawns the MCP server as a child process over stdio. When Claude decides to use a tool, it sends a JSON-RPC request; the server translates it into a UE5 Remote Control HTTP call (or a file system read/write) and returns the result.
Related MCP server: UEMCP
Prerequisites
Unreal Engine 5
Open your project in the UE5 Editor.
Go to Edit → Plugins, search for Remote Control API, enable it, and restart the editor.
Add the following to
Config/DefaultEngine.ini:
[/Script/RemoteControlAPI.RemoteControlSettings]
bEnableRemoteControlHttp=True
RemoteControlHttpServerPort=30010
bRestrictServerToLocalHost=TrueSecurity: Keep
bRestrictServerToLocalHost=True. The Remote Control API has no authentication by default — exposing it to a network without protection is a serious risk.
Node.js
Node.js v20 or later is required.
Installation
cd C:/dev/ue5_MCP
npm install
npm run buildThis compiles TypeScript to dist/. The runnable entry point is dist/index.js.
Configuration
Copy .env.example to .env and fill in your paths. The MCP server reads these as environment variables (injected via Claude Desktop config — see below).
Variable | Required | Default | Description |
| No |
| Remote Control API base URL |
| Yes (for source tools) | — | Absolute path to your project's |
| Yes (for log tool) | — | Absolute path to the |
| No | — | Adds |
| No |
| Must be exactly |
| No |
| Comma-separated allowed extensions for file writes |
| No |
| Milliseconds before a staged batch expires (default: 10 minutes) |
Connecting to Claude
Claude Code (CLI / VS Code)
Add a .mcp.json file in the root of the project you want the tools available in (or in the MCP server directory itself):
{
"mcpServers": {
"ue5": {
"type": "stdio",
"command": "node",
"args": ["C:/dev/ue5_MCP/dist/index.js"],
"env": {
"UE5_RC_URL": "http://127.0.0.1:30010",
"UE5_PROJECT_SOURCE": "C:\\Github\\MyProject\\Source",
"UE5_LOG_PATH": "C:\\Github\\MyProject\\Saved\\Logs\\MyProject.log",
"UE5_ALLOW_FILE_WRITE": "false"
}
}
}
}Alternatively, add it via the CLI:
claude mcp add --transport stdio \
--env UE5_RC_URL=http://127.0.0.1:30010 \
--env "UE5_PROJECT_SOURCE=C:\Github\MyProject\Source" \
--env "UE5_LOG_PATH=C:\Github\MyProject\Saved\Logs\MyProject.log" \
--env UE5_ALLOW_FILE_WRITE=false \
ue5 -- node C:/dev/ue5_MCP/dist/index.jsWhen you start a new Claude Code session in a directory that has this .mcp.json, the 10 UE5 tools will be available automatically. You'll be prompted to approve the server on first use.
Claude Desktop (optional)
If you also want to use it with Claude Desktop, add to %APPDATA%\Claude\claude_desktop_config.json (Windows) or ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):
{
"mcpServers": {
"ue5": {
"command": "node",
"args": ["C:/dev/ue5_MCP/dist/index.js"],
"env": {
"UE5_RC_URL": "http://127.0.0.1:30010",
"UE5_PROJECT_SOURCE": "C:\\Github\\MyProject\\Source",
"UE5_LOG_PATH": "C:\\Github\\MyProject\\Saved\\Logs\\MyProject.log",
"UE5_ALLOW_FILE_WRITE": "false"
}
}
}
}Restart Claude Desktop after editing. The hammer icon in the toolbar should show 10 tools when a conversation is active.
Available Tools
Remote Control (4 tools)
These tools communicate directly with the running UE5 editor via the Remote Control API.
ue5_run_console_command
Executes any Unreal console command in the live editor.
command: "stat fps" → shows FPS overlay
command: "r.VSync 0" → disables VSync
command: "stat unit" → shows frame time breakdown
command: "showflag.Bloom 0" → disables bloomBlocked commands:
quit,exit,open,cmd,exec,start,shell,servertravel,disconnect
ue5_get_object_property
Reads a property value from any UObject by its full actor path.
objectPath: "/Game/Maps/TestMap.TestMap:PersistentLevel.PointLight_0"
propertyName: "Intensity"ue5_set_object_property
Sets a property on any UObject.
objectPath: "/Game/Maps/TestMap.TestMap:PersistentLevel.PointLight_0"
propertyName: "Intensity"
propertyValue: 5000ue5_call_function
Calls a Blueprint-callable UFUNCTION on any actor or component.
objectPath: "/Game/Maps/TestMap.TestMap:PersistentLevel.MyActor_0"
functionName: "ResetState"
parameters: {}Source Search (2 tools)
These tools search and read files in your UE5_PROJECT_SOURCE directory. They never write anything.
ue5_search_source
Full-text regex search across .cpp and .h files with context lines.
pattern: "AGameModeBase"
fileGlob: "**/*.h" (optional, default: **/*.{cpp,h})
maxResults: 30 (optional, default: 50)
contextLines: 3 (optional, default: 2)Example output:
=== MyGame/GameMode/MyGameMode.h:8 ===
6: #include "CoreMinimal.h"
7: #include "GameFramework/GameModeBase.h"
>> 8: class MYGAME_API AMyGameMode : public AGameModeBase
9: {
10: GENERATED_BODY()ue5_read_file
Returns the content of a specific source file, optionally scoped to a line range.
filePath: "MyGame/GameMode/MyGameMode.cpp"
startLine: 20 (optional)
endLine: 50 (optional)Log Reader (1 tool)
ue5_read_log
Reads the tail of the UE5 output log. Reads only the last N bytes to avoid loading gigabyte-sized session logs.
filter: "Error" (All | Error | Warning | Display, default: All)
maxLines: 200 (default: 100)
tailBytes: 1048576 (default: 512000 = 500 KB)Use filter: "Error" after a failed compile to surface just the relevant errors.
File Writer (3 tools)
Requires
UE5_ALLOW_FILE_WRITE=truein your environment. Disabled by default. Only.cppand.hfiles are permitted. Paths are jailed toUE5_PROJECT_SOURCE.
The write workflow is a three-step process designed to give you a review gate before anything touches disk:
Step 1 — Stage
ue5_stage_files:
files: [
{ path: "MyGame/MyActor.h", content: "..." },
{ path: "MyGame/MyActor.cpp", content: "..." }
]Files are held in memory. Nothing is written yet.
Step 2 — Preview
ue5_preview_stagedReturns the full content of every staged file. Review it before proceeding.
Step 3 — Commit
ue5_commit_files:
triggerCompile: trueWrites all staged files to disk (creating directories as needed), clears the staging area, and optionally triggers a hot reload compile. Follow up with ue5_read_log filter: "Error" to check compile results.
Example Prompts
"Turn on GPU timing stats in the UE5 editor."
→ Calls ue5_run_console_command: "stat gpu"
"Set the intensity of DirectionalLight_0 to 3.14."
→ Calls ue5_set_object_property with the actor path and Intensity value
"Show me everywhere UHealthComponent is used in the project."
→ Calls ue5_search_source: pattern "UHealthComponent", maxResults 50
"My project just failed to compile. What are the errors?"
→ Calls ue5_read_log: filter "Error", maxLines 50
"Create a minimal AActor subclass called APickup with a USphereComponent."
→ Calls ue5_search_source to find conventions, then ue5_stage_files,
ue5_preview_staged for your review, then ue5_commit_files with triggerCompile: trueDevelopment
npm run dev # Run directly with ts-node (no compile step)
npm run build # Compile TypeScript → dist/
npm run start # Run compiled output
npm run inspect # Open MCP Inspector browser UI to test tools interactivelyThe MCP Inspector is the fastest way to test tools without Claude Desktop. It shows all registered tools with their schemas and lets you call them manually.
Security
Risk | Mitigation |
Arbitrary console commands | Blocked prefix allowlist; |
Remote Control API exposure | Keep |
Path traversal in file reads |
|
Source file writes | Jailed to |
Log credential exposure | Logs may contain secrets from plugin init — redact before sharing raw log output |
HTTP transport | If switching from stdio to HTTP/SSE transport, validate |
Project Structure
src/
index.ts Entry point — bootstraps MCP server, registers tools
utils/
ue5-client.ts Axios wrapper for all Remote Control API HTTP calls
log-parser.ts Pure log line parsing/filtering (no I/O)
path-guard.ts Path traversal security guard (shared by read and write tools)
tools/
remote-control.ts ue5_run_console_command, ue5_get/set_object_property, ue5_call_function
source-search.ts ue5_search_source, ue5_read_file
log-reader.ts ue5_read_log
file-writer.ts ue5_stage_files, ue5_preview_staged, ue5_commit_files
dist/ Compiled JavaScript output (generated by npm run build)
.env.example Template for environment variable configurationAvailable Tools
10 toolsue5_call_functionB
Call a Blueprint-callable UFUNCTION on any actor or component by its full Unreal object path.
Inputs: objectPath (required), functionName (required), parameters.
ue5_commit_filesA
Write all staged files (or a subset) to disk. Directories are created if needed. Optionally triggers a hot reload compile afterwards. Requires UE5_ALLOW_FILE_WRITE=true.
Inputs: paths, triggerCompile.
ue5_get_object_propertyA
Read a property value from any UObject in the current level by its full Unreal object path.
Inputs: objectPath (required), propertyName (required).
ue5_preview_stagedA
Preview the full content of all staged files before committing to disk. This is the review gate — inspect output before calling ue5_commit_files.
Inputs: filePath.
ue5_read_fileA
Read the contents of a specific C++ source file in the project Source directory. Supports optional line range to limit output for large files.
Inputs: filePath (required), endLine, startLine.
ue5_read_logA
Read recent lines from the UE5 output log. Optionally filter to only Error or Warning severity. Reads from the tail of the file to avoid loading multi-GB logs.
Inputs: filter, maxLines, tailBytes.
ue5_run_console_commandA
Execute a console command in the running UE5 editor session. Use for stat commands, CVars, level operations, actor spawning, etc. Destructive commands (quit, open, exit) are blocked.
Inputs: command (required).
ue5_search_sourceA
Search C++ and header files in the UE5 project Source directory using a regex pattern. Returns file path, line number, and surrounding context for each match.
Inputs: pattern (required), fileGlob, maxResults, contextLines.
ue5_set_object_propertyB
Set a property value on any UObject in the current level. The value must match the expected JSON type for the property.
Inputs: objectPath (required), propertyName (required), propertyValue.
ue5_stage_filesA
Stage one or more C++ files in memory for review before writing to disk. Nothing is written until ue5_commit_files is called. Requires UE5_ALLOW_FILE_WRITE=true. Only .cpp and .h files are permitted.
Inputs: files (required), allowOverwrite.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 10 tools
Each tool targets a distinct operation: console execution, object property read/write, function invocation, source search/read, log reading, and staged file editing. The only broad tool, run_console_command, is clearly framed as the engine command entry point and does not blur with the object or source tools.
All tools share the ue5_ prefix and follow lowercase snake_case with a leading verb: get, set, call, search, read, stage, preview, commit. The naming pattern is highly predictable and makes the tool surface easy to navigate.
Ten tools is well within the ideal range for a domain-specific MCP server. The set covers object inspection/mutation, console commands, source code access, log reading, and a safe file-writing workflow without unnecessary redundancy.
The core workflows are well covered, especially the staged file edit lifecycle and source/log access. The main gap is that object property and function tools require full Unreal object paths, but there is no dedicated tool for listing or discovering objects and actors; agents must rely on console commands as a workaround.
Maintenance
Related MCP Connectors
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal E…
Control Unreal Engine to browse assets, import content, and manage levels and sequences. Automate…
Create projects, nodes, and tasks in UluP Spaces by conversation with Claude.
Use AI models for chat, image, and video generation from Claude Code and other MCP hosts.
Related MCP Servers
- AlicenseAqualityCmaintenanceBridges AI assistants to Unreal Engine 5 editor, enabling direct manipulation of levels, actors, Blueprints, and Animation Blueprints through natural language commands.166MIT
- AlicenseBqualityCmaintenanceEnables Claude to control Unreal Engine 5 editor, spawn actors, build materials, author Blueprints, and more, with zero plugin installation.31312 PyPIMIT
- FlicenseAqualityDmaintenanceBridges Large Language Models with Unreal Engine 5 via the Model Context Protocol, enabling AI to control scenes, inject C++ code, and manage assets through UE5's Web Remote Control interface.20-
- FlicenseNot gradedqualityDmaintenanceMCP server that connects Claude to Unreal Engine 5.8 via the official Remote Control API, enabling asset manipulation, actor control, level operations, and AI-powered 3D model generation (via Meshy) through natural language.-