Unreal_mcp  by ChiR24

AI-powered Unreal Engine automation server

Created 5 months ago
282 stars

Top 92.9% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a high-performance Model Context Protocol (MCP) server designed to enable AI assistants to control Unreal Engine. It targets engineers, researchers, and power users seeking to automate complex game development workflows, offering ultra-high-performance control through a native C++ Automation Bridge plugin.

How It Works

The core architecture leverages a native C++ Automation Bridge plugin within Unreal Engine, routing all operations through it. The server is built with TypeScript, C++, and Rust (compiled to WebAssembly) to achieve ultra-high performance. Key design choices include dynamic type discovery for runtime introspection, graceful degradation if Unreal is not connected, on-demand connection retries, and command safety through pattern-based validation of console commands. Asset caching with a 10-second TTL and per-IP rate limiting on the Prometheus endpoint further enhance performance and stability.

Quick Start & Requirements

  • Prerequisites: Node.js 18+ and Unreal Engine 5.0–5.7.
  • Installation:
    • Recommended: npx unreal-engine-mcp-server
    • Alternatively, clone the repository, run npm install, npm run build, and execute node dist/cli.js.
  • Unreal Plugin: Copy the plugins/McpAutomationBridge folder into your Unreal project's Plugins directory or add it via the Unreal Editor.
  • Enable Plugins: Ensure "MCP Automation Bridge," "Editor Scripting Utilities," "Sequencer," and other relevant plugins are enabled in your Unreal project.
  • Client Configuration: Add MCP server details to your AI assistant's configuration file (e.g., Claude Desktop/Cursor), specifying the UE_PROJECT_PATH environment variable.
  • Links: Video Guide for plugin installation: https://github.com/user-attachments/assets/d8b86ebc-4364-48c9-9781-de854bf3ef7d

Highlighted Details

  • Extensive Toolset: Offers a comprehensive suite of tools covering asset management, actor control, editor operations, level management, animation, visual effects, Sequencer, graph editing, audio, and system control.
  • WebAssembly Acceleration: Optional Wasm acceleration provides significant speedups (5–10x) for computationally intensive tasks like JSON parsing, transform calculations, and vector/matrix math.
  • GraphQL API: An optional GraphQL endpoint is available for complex querying needs.
  • Docker Support: A Dockerfile is provided for containerized deployment.

Maintenance & Community

The project features a public roadmap tracking development across 47 phases. Community interaction is facilitated through GitHub Discussions and Issues. Contributions are welcomed following provided guidelines.

Licensing & Compatibility

The project is released under the MIT license, which is permissive and generally suitable for commercial use and integration into closed-source projects.

Limitations & Caveats

Some features, such as the Subobject Data Interface for Blueprint components, may require specific Unreal Engine versions (UE 5.7+). WebAssembly and GraphQL functionalities are optional and require explicit enabling via environment variables. Proper configuration of environment variables and client settings is crucial for operation.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
49
Issues (30d)
5
Star History
69 stars in the last 30 days

Explore Similar Projects

Starred by Elvis Saravia Elvis Saravia(Founder of DAIR.AI), Chip Huyen Chip Huyen(Author of "AI Engineering", "Designing Machine Learning Systems"), and
5 more.

activepieces by activepieces

0.3%
21k
Open-source Zapier alternative for AI workflow automation
Created 3 years ago
Updated 1 day ago
Feedback? Help us improve.