MCP Unreal Server

🚀 MCP Unreal Server

MCP Unreal Server is a server implementation for interacting with Unreal Engine instances through remote Python execution.

🚀 Quick Start

MCP Unreal Server enables seamless interaction with Unreal Engine instances via remote Python execution. This README will guide you through installation, configuration, and usage.

✨ Features

• 🚀 Unreal Instance Management

  • Automatically discover Unreal nodes via multicast.
  • Monitor node status in real - time.
  • List resources through an LSP - compatible client.

• 💻 Remote Execution

  • Execute Python code in the Unreal Engine environment.
  • Support attended and unattended execution modes.
  • Offer file execution and statement evaluation modes.

• 📊 Logging and Monitoring

  • Output detailed logs to a file (mcp_unreal.log).
  • Provide console logs with different verbosity levels.
  • Monitor the health of node connection status.

📦 Installation

# Clone the repository
git clone https://github.com/your-org/mcp-unreal-server.git
cd mcp-unreal-server

# Install dependencies
pip install -r requirements.txt

📚 Documentation

Configuration

Network Settings

Configure multicast parameters in RemoteExecutionConfig:

# Default multicast settings (modify in server.py)
config.multicast_group_endpoint = ("239.0.0.1", 6766)

Logging

Adjust the log level in server.py:

# Adjust the log level
file_handler.setLevel(logging.DEBUG)  # File log
console_handler.setLevel(logging.INFO)  # Console log

Usage

Start the Server

python -m src.mcp_server_unreal.server

Supported Tools

1. Connect to an Unreal Instance

{
  "host": "239.0.0.1",
  "port": 6766
}

2. Execute Python Code

{
  "node_id": "<unreal-node-id>",
  "code": "print('Hello Unreal')",
  "unattended": true
}

API Documentation

Resource Format

types.Resource(
    uri="unreal://<node_id>",
    name=f"Unreal Instance: {node_id}",
    description="Unreal Engine instance",
    mimeType="application/x-unreal"
)

Execution Modes

Troubleshooting

Common Issues:

• No nodes are discovered: Ensure that the Unreal instance is running and the MCP plugin is enabled.
• Execution times out: Check if the firewall settings allow multicast traffic.
• Connection is interrupted: Monitor node status changes in mcp_unreal.log.

📄 License

This project is licensed under the Apache - 2.0 license.