MCP Unreal Server
@MCP-Mirror
Mirror of
Overview
What is MCP Unreal Server?
MCP Unreal Server is an MCP (Model Context Protocol) server that enables interaction with Unreal Engine instances through remote Python execution. It automatically discovers Unreal nodes via multicast, provides real-time node monitoring, and allows executing Python code in both attended and unattended modes. It is designed for developers using Unreal Engine with LSP-compatible MCP clients.
How to use MCP Unreal Server?
Install by cloning the repository and running pip install -r requirements.txt. Start the server with python -m src.mcp_server_unreal.server. Configure multicast group endpoint (default 239.0.0.1:6766) and logging verbosity in server.py. Use tools like connect_to_instance and execute_python_code with appropriate JSON parameters (host, port, node_id, code, unattended flag).
Key features of MCP Unreal Server
- Automatic multicast discovery of Unreal nodes
- Remote Python code execution in Unreal Engine
- Attended and unattended execution modes
- Real-time node status and health monitoring
- Logging to
mcp_unreal.logwith configurable verbosity - LSP-compatible client resource listing
Use cases of MCP Unreal Server
- Execute Python scripts on a remote Unreal instance for automation
- Run unattended Python commands to control Unreal Engine processes
- Monitor Unreal node health and connection status through logging
- Evaluate Python expressions in Unreal Engine for debugging
FAQ from MCP Unreal Server
How do I discover Unreal nodes?
Ensure Unreal instances are running with the MCP plugin enabled. The server discovers nodes automatically via multicast on the configured group endpoint.
Why am I getting execution timeouts?
Execution timeouts are often caused by firewall settings blocking multicast traffic. Verify that your network allows multicast on the configured port and group address.
How can I monitor connection drops?
Monitor the mcp_unreal.log file for node status changes. The log provides detailed information about connection health and node availability.
What are the runtime dependencies for MCP Unreal Server?
The server requires Python 3 and the packages listed in requirements.txt. Install them by running pip install -r requirements.txt after cloning the repository.
