Skip to main content
Glama
README.md
# Unreal Engine 5 MCP Bridge

## 📖 Project Overview
This project is a lightweight, high-performance server application based on the **Model Context Protocol (MCP)**. It serves as an ultimate bridge between Large Language Models (like Claude) and Unreal Engine 5 (UE5).

By integrating directly with UE5's native Web Remote Control interface, this project empowers AI to **interact directly with the underlying Unreal Engine**. AI can not only query and modify assets within the engine but also dynamically inject C++ code, compile core modules, and manipulate all elements within the scene with high-level privileges.

## ✨ Core Features

- 🔌 **Real-time Bidirectional Remote Control**: 
  Deep integration with UE5 Web Remote Control via HTTP/JSON protocols, enabling zero-latency instruction execution.
- 🧱 **C++ Blueprint Code Injection & Compilation**:
  Supports AI in writing native C++ Actors and Blueprint Function Libraries in the background, and triggering cross-process Live Coding compilation with a single command.
- 🎮 **Automated Scene & Viewport Management**:
  Includes a suite of advanced tools, such as:
  - `ue5_spawn_actors_batch`: High-performance batch generation and alignment of objects (e.g., spawning circles or array matrices).
  - `ue5_pilot_actor`: Takes over the editor camera, enabling AI-level automated cinematic movements and scene touring.
  - `ue5_build_lighting`: Automated scene lighting builds.
- 🎨 **Automated Asset Assembly**:
  Supports dynamic retrieval of materials and automatic assignment to scene meshes, enabling one-click material swapping and beautiful level generation.

## 🚀 Quick Start
1. Ensure the `Web Remote Control` plugin is enabled in Unreal Engine, and start the server (default port: 30010).
2. Run `npm install` in the root directory of this project to install dependencies.
3. Run `npm run build` to build the project.
4. Connect to UE5 by mounting this project in your MCP client configuration.

## 🛠 Tech Stack
- **Node.js / TypeScript**: MCP Server Core Logic
- **Model Context Protocol SDK**: Official Communication Standard
- **Unreal Engine 5 Web Remote Control**: Unreal Engine Native Open API

---
*Generated with AI assistance. Bridging the gap between Language Models and Game Engines.*

TDQS

A3.5/5.0

Scored across 20 tools

Disambiguation4/5

Most tools have clearly distinct purposes. There is slight overlap between get_property/set_property and call_function for property access, but descriptions clarify when to use each.

Naming Consistency4/5

All tools use a consistent 'ue5_' prefix and mostly follow verb_noun snake_case. Minor deviations include 'new_level' (adjective+noun) and 'ping' (verb only).

Tool Count5/5

With 20 tools, the scope is well-calibrated for Unreal Engine editor automation, covering asset management, level operations, actor manipulation, and debugging without being excessive.

Completeness4/5

The tool set covers core CRUD operations for assets and actors, level management, and property access. Minor gaps exist, such as limited support for component properties and no explicit undo tool, but these are workable.

Maintenance

ActivityInactive
ResponsivenessNo issues