unreal-mcp-ue4
UE4.27.2-focused MCP server for Unreal Engine using Unreal Python Remote Execution
接入你的智能体
發布者自己的指令。不是 PlugMCP 端點。
用我們的金鑰與日誌託管一份副本。
npx -y [email protected]Claude Code 沒有本機指令的安裝連結。複製下方指令並在終端機中執行。
claude mcp add io.github.conaman-unreal-mcp-ue4 -- npx -y unreal-mcp-ue4@2026.4.1-2在終端機中執行。
{ "mcpServers": { "io.github.conaman-unreal-mcp-ue4": { "command": "npx", "args": [ "-y", "[email protected]" ] } }}claude_desktop_config.json
遠端 URL 還是本機指令? 兩種安裝方式的差異
unreal-mcp-ue4 started from the core idea and early workflow shape of runreal/unreal-mcp, but it has since been heavily refactored for Unreal Engine 4.27.2 and expanded with many new tools, UE4-specific compatibility layers, documentation, and smoke coverage. At this point, the original inspiration remains, but the public surface and day-to-day behavior are substantially different and UE4-first.
This port and the follow-up tool, documentation, and smoke-test work were developed with assistance from OpenAI Codex.
This project is still under active development, so bugs, rough edges, and UE4.27-specific limitations may still surface.
Published package:
unreal-mcp-ue4
Registry name:io.github.conaman/unreal-mcp-ue4
4.27.218+npmThis is the most important setup step: your MCP client must know how to launch unreal-mcp-ue4.
Recommended global install:
npm install -g unreal-mcp-ue4
After the global install, use the published unreal-mcp-ue4 binary in your client configuration.
One-off invocation with npx:
npx unreal-mcp-ue4
Local source checkout:
git clone https://github.com/conaman/unreal-mcp-ue4.git
cd unreal-mcp-ue4
npm install
npm run build
Successful build output should create dist/bin.js, dist/index.js, and dist/editor/tools.js. Use the dist/bin.js path in the local source checkout examples below.
Use the global examples when you installed with npm install -g unreal-mcp-ue4. Use the local source checkout examples when you are developing from a cloned repository.
Global npm install:
claude mcp add --scope user unreal-mcp-ue4 -- unreal-mcp-ue4
Local source checkout:
claude mcp add --scope user unreal-mcp-ue4 -- node /absolute/path/to/unreal-mcp-ue4/dist/bin.js
Global npm install:
codex mcp add unreal-ue4 -- unreal-mcp-ue4
Local source checkout:
codex mcp add unreal-ue4 -- node /absolute/path/to/unreal-mcp-ue4/dist/bin.js
Create or update .vscode/mcp.json.
Global npm install:
{
"servers": {
"unreal-ue4": {
"command": "unreal-mcp-ue4",
"args": []
}
}
}
Local source checkout:
{
"servers": {
"unreal-ue4": {
"command": "node",
"args": [
"/absolute/path/to/unreal-mcp-ue4/dist/bin.js"
]
}
}
}
Then start the server from the MCP config UI and verify that unreal-ue4 appears in the tools picker.
Official Copilot docs:
This repository does not ship its own Unreal plugin. Instead, it depends on built-in editor features that must be enabled in your UE4.27.2 project.
In Unreal Editor:
Edit -> Plugins.Python Editor Script Plugin.Editor Scripting Utilities.SequencerScripting if you want to use advanced manage_sequence actions such as actor binding, track or key edits, camera cuts, playback ranges, and speed-track analysis.Edit -> Project Settings -> Python.Enable Remote Execution.Notes:
manage_* namespace tools as the main MCP surface.params keys per action instead of relying only on trial and error.manage_editor.project_info as the canonical project summary entry point.manage_editor.map_info and manage_level.world_outliner as the canonical map and level read entry points.manage_editor.run_python as an escape hatch for debugging, rapid prototyping, and UE4.27 API gaps that are not yet wrapped as stable tools.Enable Remote Execution are enabled.npm install -g unreal-mcp-ue4, or build your local checkout with npm run build.Useful first commands:
unreal-mcp-ue4 --version to print the MCP server package version without starting stdio transport.manage_editor with action: "project_info"manage_editor with action: "map_info"manage_level with action: "world_outliner"manage_tools with action: "list_namespaces"Useful first natural-language requests:
Get project info from the unreal-ue4 server.List the actors in the current level.Spawn a StaticMeshActor named TestCube at 0,0,100.DataAsset and StringTable assets.action and params.Use this when you want to verify MCP startup, tool discovery, namespace action schemas, and action-specific parameter validation without launching Unreal Editor.
npm run test:no-unreal
The smoke test builds the server, launches its own local MCP server process, connects to the already running Unreal Editor, and runs a deterministic validation flow. You do not need to start a separate MCP server manually before this test.
npm run test:e2e
This checks:
npm run test:e2e -- --with-assets
This adds:
/Game/MCP/TestsUseful options:
npm run test:e2e -- --with-assets --keep-assets keeps the generated test assets so you can inspect them in the Content Browser after the run.npm run test:e2e -- --skip-namespace skips the namespace-dispatch portion of the smoke run.npm run test:e2e -- --verbose prints MCP server stderr during the run.npm run test:e2e -- --help prints the runner options without rebuilding the server.Open PowerShell in the repository folder:
cd C:\dev\unreal-mcp-ue4
npm install
npm run test:no-unreal
npm run test:e2e
npm run test:e2e -- --with-assets
[PASS] for every test step./Game/MCP/Tests and then removes them before exit unless --keep-assets is used.npm run test:no-unreal.npm run test:e2e.npm run test:e2e -- --with-assets.The package is published to npm as a public package.
The project version format is unified everywhere as the semver-compatible date form YYYY.M.D-N. For example, 2026.5.8-1 follows this format.
Recommended maintainer flow:
npm run publish:check
npm run test:e2e -- --with-assets --skip-build
npm publish --tag latest
Notes:
prepack runs npm run build, so the published tarball always uses a fresh dist.npm run publish:check verifies typecheck, rebuilds the package, and runs npm pack --dry-run so you can inspect the exact tarball contents before publishing.latest.Remote node is not availablePython Editor Script Plugin is enabled.Editor Scripting Utilities is enabled.Enable Remote Execution is enabled in project settings.UnrealEditor.exe and node.exe through Windows Defender Firewall.239.0.0.1:6766 and opens the command channel on port 6776.UNREAL_MCP_BIND_ADDRESS or UNREAL_MCP_COMMAND_ADDRESS if Unreal cannot discover or connect to the MCP process.unreal-mcp-ue4 or nodePATH.PATH, use an absolute path to the global unreal-mcp-ue4 executable.node or node.exe instead of relying on PATH.Excluded Capability Areas in the tool section.PanelWidget parents, but delegate binding helpers remain unavailable in stock UE4.27 Python.CanvasPanel slots in UE4.27. Use manage_widget.ensure_canvas_root when a Widget Blueprint has a non-Canvas root but needs CanvasPanel-style positioning.The tool list below is generated from the TypeScript tool catalog during build.
Notes call out important requirements or UE4.27 limitations when they matter. Empty notes mean there are no additional caveats beyond normal editor setup.
The recommended public surface is the manage_* namespace layer. Prefer manage_editor.project_info, manage_editor.map_info, and manage_level.world_outliner as canonical read entry points, and treat the small direct-tool set as low-level primitives for path discovery and actor CRUD.
These capability areas are intentionally not exposed through the MCP surface in this UE4.27 port because they fail reliably in the current Python environment and only add prompt or context overhead until a native bridge exists.
Licensed under the MIT License.
UE4.27 MCP server for controlling Unreal Editor sessions over Python Remote Execution.
{ "mcpServers": { "io.github.conaman-unreal-mcp-ue4": { "command": "npx", "args": [ "-y", "[email protected]" ] } }}工具
尚無工具清單。遠端伺服器會在首次健康檢查後取得工具清單。
常見問題
在本頁複製適用於 Cursor、Claude Desktop、Claude Code 或 VS Code 的 stdio 設定。它使用發布者的安裝方式,而不是 PlugMCP 代理伺服器。
這筆記錄未列出必要的環境變數。
Unreal MCP Ue4 透過 stdio 在本機執行。
上次檢查時間:2026-11-09。 UE4.27 MCP server for controlling Unreal Editor sessions over Python Remote Execution.