Unreal_mcp
installs/mo · npmstarsforks
How to install Unreal_mcp?
chir24/unreal_mcp
$git clone https://github.com/ChiR24/Unreal_mcpA comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal Engine through a native C++ Automation Bridge plugin. Built with TypeScript and C++.
README.md
| 1 | # Unreal Engine MCP Server |
| 2 | |
| 3 | [](https://opensource.org/licenses/MIT) |
| 4 | [](https://www.npmjs.com/package/unreal-engine-mcp-server) |
| 5 | [](https://github.com/modelcontextprotocol/sdk) |
| 6 | [](https://www.unrealengine.com/) |
| 7 | [](https://registry.modelcontextprotocol.io/) |
| 8 | [](https://github.com/users/ChiR24/projects/3) |
| 9 | [](https://github.com/ChiR24/Unreal_mcp/discussions) |
| 10 | |
| 11 | A comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal Engine through a native C++ Automation Bridge plugin. Built with TypeScript and C++. |
| 12 | |
| 13 | --- |
| 14 | |
| 15 | ## Table of Contents |
| 16 | |
| 17 | - [Features](#features) |
| 18 | - [Getting Started](#getting-started) |
| 19 | - [Configuration](#configuration) |
| 20 | - [Available Tools](#available-tools) |
| 21 | - [Docker](#docker) |
| 22 | - [Documentation](#documentation) |
| 23 | - [Community](#community) |
| 24 | - [Development](#development) |
| 25 | - [Contributing](#contributing) |
| 26 | |
| 27 | --- |
| 28 | |
| 29 | ## Features |
| 30 | |
| 31 | | Category | Capabilities | |
| 32 | |----------|-------------| |
| 33 | | **Asset Management** | Browse, import, duplicate, rename, delete assets; create materials | |
| 34 | | **Actor Control** | Spawn, delete, transform, physics, tags, components | |
| 35 | | **Editor Control** | PIE sessions, camera, viewport, screenshots, bookmarks | |
| 36 | | **Level Management** | Load/save levels, streaming, lighting | |
| 37 | | **Animation & Physics** | Animation BPs, state machines, ragdolls, vehicles, constraints | |
| 38 | | **Visual Effects** | Niagara particles, GPU simulations, procedural effects, debug shapes | |
| 39 | | **Sequencer** | Cinematics, timeline control, camera animations, keyframes | |
| 40 | | **Graph Editing** | Blueprint, Niagara, Material, and Behavior Tree graph manipulation | |
| 41 | | **Audio** | Sound cues, audio components, sound mixes, ambient sounds | |
| 42 | | **System** | Console commands, UBT, tests, logs, project settings, CVars | |
| 43 | |
| 44 | ### Architecture |
| 45 | |
| 46 | - **Native C++ Automation** — All operations route through the MCP Automation Bridge plugin |
| 47 | - **Dual Transport** — Native HTTP/SSE (no bridge needed) or WebSocket via TypeScript bridge |
| 48 | - **Dynamic Type Discovery** — Runtime introspection for lights, debug shapes, and sequencer tracks |
| 49 | - **Graceful Degradation** — Server starts even without an active Unreal connection |
| 50 | - **On-Demand Connection** — Retries automation handshakes with exponential backoff |
| 51 | - **Command Safety** — Blocks dangerous console commands with pattern-based validation |
| 52 | - **Capability Token Auth** — Optional token-based authentication for both WS and HTTP transports |
| 53 | - **Asset Caching** — 10-second TTL for improved performance |
| 54 | - **Metrics Rate Limiting** — Per-IP rate limiting (60 req/min) on Prometheus endpoint |
| 55 | - **Centralized Configuration** — Unified class aliases and type definitions |
| 56 | |
| 57 | --- |
| 58 | |
| 59 | ## Getting Started |
| 60 | |
| 61 | ### Prerequisites |
| 62 | |
| 63 | - **Unreal Engine** 5.0–5.8 (5.8 preview validated) |
| 64 | |
| 65 | Choose your transport: |
| 66 | - **Option A: Native MCP** (recommended) — no additional dependencies |
| 67 | - **Option B: TypeScript Bridge** — requires **Node.js** 18+ |
| 68 | |
| 69 | ### Step 1: Install MCP Server (Option B only — skip for Native MCP) |
| 70 | |
| 71 | > Skip this step if using **Option A: Native MCP Transport** ([Step 4A](#option-a-native-mcp-transport-direct-http--no-bridge-needed) below). |
| 72 | |
| 73 | **NPX (Recommended):** |
| 74 | ```bash |
| 75 | npx unreal-engine-mcp-server |
| 76 | ``` |
| 77 | |
| 78 | **Clone & Build:** |
| 79 | ```bash |
| 80 | git clone https://github.com/ChiR24/Unreal_mcp.git |
| 81 | cd Unreal_mcp |
| 82 | npm install |
| 83 | npm run build |
| 84 | node dist/cli.js |
| 85 | ``` |
| 86 | |
| 87 | ### Step 2: Install Unreal Plugin |
| 88 | |
| 89 | The MCP Automation Bridge plugin is included at `Unreal_mcp/plugins/McpAutomationBridge`. |
| 90 | |
| 91 | #### From source (requires a project with code target) |
People who liked this also viewed
6 picksType
- fastmcp🚀 The fast, Pythonic way to build MCP servers and clients.MCP ServersJul 2026
- playwright-mcpPlaywright MCP serverMCP ServersJul 2026
- ext-appsOfficial repo for spec & SDK of MCP Apps protocol - standard for UIs embedded AI chatbots, served by MCP serversMCP ServersJul 2026
- langchain-mcp-adaptersLangChain 🔌 MCPMCP ServersJul 2026
- mcporterCall MCPs via TypeScript, masquerading as simple TypeScript API. Or package them as cli.MCP ServersJul 2026
- mcp-proxyA bridge between Streamable HTTP and stdio MCP transportsMCP ServersJul 2026
