Unreal Engine MCP Server For Claude Desktop

🚀 Unreal Engine MCP Server for Claude Desktop

This repository houses an MCP Python server that enables Claude Desktop to interact with Unreal Engine 5.3 (via the remote control API) through text prompts, facilitating the creation and manipulation of 3D objects. This integration empowers Claude to construct and modify 3D scenes in Unreal Engine using natural language, marking a significant step towards text-to-game generation technology.

🚀 Quick Start

1. Requirements

• Python 3.10+
• Unreal Engine 5.3 with the Remote Control API plugin enabled
• Claude Desktop for Windows

2. Installation

Clone the repository and install the required packages:

git clone https://github.com/runeape-sats/unreal-mcp.git
cd unreal-mcp
pip install uv mcp requests

3. Configure Claude Desktop

Navigate to Claude Desktop → File → Settings → Developer → Edit the configuration claude_desktop_config.json, and add the following content. Adjust the local repository path as needed:

{
  "mcpServers": {
    "unreal-mcp": {
      "command": "uv",
      "args": ["--directory", "\\path\\to\\unreal-mcp", "run unreal_mcp_server.py"],
      "env": {}
    }
  }
}

4. Launch Unreal Engine

Start Unreal Engine and ensure that the Remote Control API plugin is enabled.

5. Launch Claude Desktop

Run the following command to start the MCP server:

mcp run unreal_mcp_server.py

📁 Project Structure

• unreal_mcp_server.py: The interface for interacting with Claude.
• commands/: Defines various functional commands, such as creating geometries and moving objects.

✨ Features

Basic Operations

1. Create Geometries

   • Use create_cube() to create a cube.
   • Use create_sphere() to create a sphere.
   • Use create_cylinder() to create a cylinder.

2. Transformation Operations

   • Use set_position(x, y, z) to set the object's position.
   • Use set_rotation(x, y, z) to set the object's rotation angle.
   • Use set_scale(x, y, z) to adjust the object's scale.

3. Delete Objects

   • Use delete_object() to delete a specified object.

Advanced Features

• Batch Operations: Supports performing the same operation on multiple objects simultaneously, such as moving and rotating.
• Scene Saving/Loading: Allows saving the current scene and reloading previously saved scenes.
• Material Modification: Enables adjusting the material properties of objects, such as color and texture.

💻 Usage Examples

Create Basic Geometries

# Create a red cube
cube = create_cube()
set_color(cube, (1, 0, 0))

# Create a blue sphere
sphere = create_sphere()
set_color(sphere, (0, 0, 1))

Transformation Operation Examples

# Move the cube to a specified position
set_position(cube, (5, 0, 0))

# Rotate 90 degrees around the Y-axis
set_rotation(cube, (0, 90, 0))

# Adjust the scale
set_scale(cube, (2, 1, 1))

🛠️ Troubleshooting

Connection Issues

• Ensure that both Unreal Engine and Claude Desktop are running and have a stable network connection.
• Check the firewall settings to ensure that the ports are not blocked.

Objects Not Displaying

• Check the Unreal Engine log files for error messages.
• Ensure that the object creation position is within a reasonable range, avoiding being too far from the origin (0,0,0).
• Try simplifying the requests to isolate the problem.

🛠️ Development

To run the server in development mode:

pip install mcp[cli]
mcp dev unreal_mcp_server.py

🤝 Contribution

Contributions are welcome! This is an integration project between Claude and Unreal Engine, and there is still much room for improvement:

• Enhance natural language processing capabilities to better understand scene descriptions.
• Add more complex object creation functions.
• Support more Unreal Engine features.
• Improve error handling and feedback mechanisms.

📄 License

MIT License