unreal-mcp-ue4
UE4.26.2 / UE4.27-focused MCP server for Unreal Engine using Unreal Python Remote Execution
Power your agent
คำสั่งของผู้เผยแพร่เอง ไม่ใช่เอนด์พอยต์ของ PlugMCP
Host a copy with our keys and logs.
npx -y @pjkui/[email protected]Claude Code ไม่มีลิงก์ติดตั้งสำหรับคำสั่งแบบโลคัล ให้คัดลอกคำสั่งด้านล่างแล้วรันในเทอร์มินัล
claude mcp add pjkui-unreal-mcp-ue4 -- npx -y @pjkui/unreal-mcp-ue4@2026.4.30-2รันในเทอร์มินัล
{ "mcpServers": { "pjkui-unreal-mcp-ue4": { "command": "npx", "args": [ "-y", "@pjkui/[email protected]" ] } }}claude_desktop_config.json
URL แบบรีโมตหรือคำสั่งบนเครื่องของคุณ? การติดตั้งสองแบบต่างกันอย่างไร
รันบน PlugMCP
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
เปิดจากผู้เผยแพร่
UE4.26.2 / UE4.27-focused MCP server for Unreal Engine using Unreal Python Remote Execution
UE4.26.2 / UE4.27.2-focused MCP server for controlling the Unreal Editor through Unreal Python Remote Execution. Also published on npm as 'ue4-mcp' (shorter name, same code). Fork of conaman/unreal-mcp-ue4 with UE4.26 compatibility and Chinese documentati
中文文档:README_zh.md
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.26.2 and 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.26/4.27-specific limitations may still surface.
Published packages (same code, shipped under two names):
- Short alias:
ue4-mcp— recommended for end-users- Canonical scoped name:
@pjkui/unreal-mcp-ue4Registry name:
io.github.pjkui/unreal-mcp-ue4This is an independent fork. The original
unreal-mcp-ue4npm package is still maintained at conaman/unreal-mcp-ue4; see Credits & Attribution below.
This project is a derivative work, distributed under the MIT License. The original copyright notices are retained and the original authors are gratefully acknowledged.
conaman. The current unreal-mcp-ue4 npm package, the UE4.27-focused refactor, the tool-namespace layer, the smoke-test suite, and most of the existing documentation come from this repository. Much of the code in this fork is still based directly on that work.pjkui. Adds UE4.26.2 compatibility, Chinese documentation (README_zh.md), packaging tweaks, and miscellaneous fixes.Thanks to runreal for open-sourcing the original implementation, and to conaman for the substantial UE4-oriented refactor and for publishing unreal-mcp-ue4 on npm. If you build on this project, please also credit the upstream projects above.
See the LICENSE file for the full copyright statement.
4.26.2 or 4.27.218+npmThis repository does not ship its own Unreal plugin. Instead, it depends on built-in editor features that must be enabled in your UE4.26.2 or UE4.27.2 project.
Python Editor Script PluginEditor Scripting UtilitiesEdit -> Project Settings -> Python -> Enable Remote Executiongit clone https://github.com/pjkui/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.
Once the package is published on npm, you can install it directly instead of cloning the repository.
Global install (recommended for end-users):
npm install -g ue4-mcp
One-off invocation with npx:
npx --yes ue4-mcp
The exact same code is also published as the scoped package @pjkui/unreal-mcp-ue4; pick whichever fits your workflow:
npm install -g @pjkui/unreal-mcp-ue4
# or one-off:
npx --yes -p @pjkui/unreal-mcp-ue4 ue4-mcp
Either package ships the same CLI binary named ue4-mcp.
In Unreal Editor:
Open the target UE4.26.2 or UE4.27.2 project.
Go to Edit -> Plugins.
Enable Python Editor Script Plugin.
Enable Editor Scripting Utilities.
Restart the editor if prompted.
Go to Edit -> Project Settings -> Python.
Enable Enable Remote Execution.
Restart the editor again if needed.
Most clients use a local stdio server command. Pick the option that best matches how you installed the server.
ue4-mcp commandInstall once:
npm install -g ue4-mcp
# equivalent: npm install -g @pjkui/unreal-mcp-ue4
Then in the client config just call the binary directly:
{
"mcpServers": {
"unreal-ue4": {
"command": "ue4-mcp"
}
}
}
This is the fastest option to start (no cold-start download per launch), is easy for users to understand, and works the same way on macOS, Linux, and Windows as long as the npm global bin directory is on PATH.
If your MCP client cannot find ue4-mcp on PATH, use the absolute path to the installed binary:
# locate it:
npm root -g
# Windows example: C:\Users\<you>\AppData\Roaming\npm\node_modules
# The binary sits next to node_modules at:
# C:\Users\<you>\AppData\Roaming\npm\ue4-mcp.cmd
# /usr/local/bin/ue4-mcp on macOS/Linux
{
"mcpServers": {
"unreal-ue4": {
"command": "C:\\Users\\YourName\\AppData\\Roaming\\npm\\ue4-mcp.cmd"
}
}
}
Behind a corporate npm mirror? Some mirrors deliver corrupted
ajvtarballs which will make this server fail to start. Install against the public registry instead:npm install -g ue4-mcp --registry=https://registry.npmjs.org/.
npx (no global install, always-latest)Good if you want to always pick up the newest release without re-installing:
{
"mcpServers": {
"unreal-ue4": {
"command": "npx",
"args": ["--yes", "ue4-mcp@latest"]
}
}
}
Force the public npm registry (strongly recommended if your default is a corporate mirror):
{
"mcpServers": {
"unreal-ue4": {
"command": "npx",
"args": ["--yes", "ue4-mcp@latest"],
"env": {
"npm_config_registry": "https://registry.npmjs.org/"
}
}
}
}
Trade-off: each cold start may take a few seconds while npx checks for updates, and if the ~/.npm/_npx cache gets corrupted by a flaky mirror you will need to clear it manually.
When iterating on this repository itself and you do not want to publish, point the client at the freshly built dist/bin.js:
{
"mcpServers": {
"unreal-ue4": {
"command": "node",
"args": [
"/absolute/path/to/unreal-mcp-ue4/dist/bin.js"
]
}
}
}
If node is already on your PATH, "command": "node" is enough; otherwise use the absolute path to the node executable. Remember to run npm run build after every change.
Once the package is installed globally:
codex mcp add unreal-ue4 -- ue4-mcp
Or via npx (no global install):
codex mcp add unreal-ue4 -- npx --yes ue4-mcp@latest
Local development fallback:
codex mcp add unreal-ue4 -- /absolute/path/to/node /absolute/path/to/unreal-mcp-ue4/dist/bin.js
Note: the CLI binary is
ue4-mcp. Both npm package names (ue4-mcpand@pjkui/unreal-mcp-ue4) expose the same executable; if you install both globally they overwrite each other harmlessly since they are the same code.
For VS Code, create .vscode/mcp.json.
Recommended (global install):
{
"servers": {
"unreal-ue4": {
"command": "ue4-mcp"
}
}
}
Using npx instead:
{
"servers": {
"unreal-ue4": {
"command": "npx",
"args": ["--yes", "ue4-mcp@latest"]
}
}
}
Local development:
{
"servers": {
"unreal-ue4": {
"command": "node",
"args": [
"C:\\Users\\YourName\\dev\\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:
manage_* namespace tools as the main MCP surface.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 run build.Useful first commands:
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.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: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:e2e.npm run test:e2e -- --with-assets.This repository is dual-published under two npm package names that share the exact same built artifact:
ue4-mcp (short, non-scoped public name)@pjkui/unreal-mcp-ue4 (scoped canonical name)The project version format is unified everywhere as the semver-compatible date form YYYY.M.D-N. For example, this fork's current release is 2026.4.23-2.
Recommended maintainer flow:
npm run set:version 2026.4.23-3 (updates package.json, package-lock.json, server.json, server/version.ts in one shot).npm run publish:check
npm run test:e2e -- --with-assets --skip-build
Bypass 2FA requirement when publishing enabled, or a one-time TOTP code):# with a granular token
NPM_TOKEN=npm_xxx npm run publish:both
# with a 2FA one-time code
npm run publish:both -- --otp=123456
# simulate only, no auth needed
npm run publish:both -- --dry-run
Notes:
scripts/publish-both.mjs publishes @pjkui/unreal-mcp-ue4 with package.json untouched, then temporarily rewrites the name field to ue4-mcp, publishes again, and restores package.json. The token is never written to ~/.npmrc.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.--tag latest so npm install resolves to them by default.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.unreal-remote-execution package uses UDP multicast discovery on 239.0.0.1:6766 and a localhost command channel on 127.0.0.1:6776.nodenode or node.exe in the MCP config instead of relying on PATH.Excluded Capability Areas in the tool section.CanvasPanel slots in UE4.27.The tool list below is generated from server/index.ts during build.
Notes call out important requirements or UE4.26/4.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.26/4.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.
This project is a derivative work. Copyright is held jointly by runreal (original project), Seungjee Baek / conaman (the UE4-focused fork and original npm publisher of unreal-mcp-ue4), and pjkui (this fork). All prior copyright notices are retained as required by the MIT License. See the LICENSE file and the Credits & Attribution section for details.
UE4.26.2 / UE4.27.2-focused MCP server for controlling the Unreal Editor through Unreal Python Remote Execution. Also published on npm as 'ue4-mcp' (shorter name, same code). Fork of conaman/unreal-mc
{ "mcpServers": { "pjkui-unreal-mcp-ue4": { "command": "npx", "args": [ "-y", "@pjkui/[email protected]" ] } }}ภาพรวม
UE4.26.2 / UE4.27.2-focused MCP server for controlling the Unreal Editor through Unreal Python Remote Execution. Also published on npm as 'ue4-mcp' (shorter name, same code). Fork of conaman/unreal-mcp-ue4 with UE4.26 compatibility and Chinese documentati
เครื่องมือ
ยังไม่มีรายการเครื่องมือ เซิร์ฟเวอร์แบบรีโมตจะได้รายการหลังการตรวจสอบสถานะครั้งแรก
FAQ
คัดลอกคอนฟิก stdio สำหรับ Cursor, Claude Desktop, Claude Code หรือ VS Code ได้ในหน้านี้ คอนฟิกนี้ใช้การติดตั้งของผู้เผยแพร่ ไม่ใช่พร็อกซีของ PlugMCP
ระเบียนนี้ไม่ได้ระบุตัวแปรสภาพแวดล้อมที่จำเป็น
@pjkui/unreal MCP Ue4 ทำงานแบบโลคัลผ่าน stdio
ตรวจสอบล่าสุดเมื่อ 2026-11-16 UE4.26.2 / UE4.27.2-focused MCP server for controlling the Unreal Editor through Unreal Python Remote Execution. Also published on npm as 'ue4-mcp' (shorter name, same code). Fork of conaman/unreal-mcp-ue4 with UE4.26 compatibility and Chinese documentati