Skip to content

README.md

Latest commit

 

History

History
40 lines (28 loc) · 1.39 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.39 KB

Unreal MCP

Python bridge for interacting with Unreal Engine 5.5 using the Model Context Protocol (MCP).

Setup

  1. Make sure Python 3.10+ is installed
  2. Install uv if you haven't already: 
    curl -LsSf https://astral.sh/uv/install.sh | sh
  3. Create and activate a virtual environment: 
    uv venv
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate     # On Windows
  4. Install dependencies: 
    uv pip install -e .

At this point, you can configure your MCP Client (Claude Desktop, Cursor, Windsurf) to use the Unreal MCP Server as per the Configuring your MCP Client.

Testing Scripts

There are several scripts in the scripts folder. They are useful for testing the tools and the Unreal Bridge via a direct connection. This means that you do not need to have an MCP Server running.

You should make sure you have installed dependencies and/or are running in the uv virtual environment in order for the scripts to work.

Troubleshooting

  • Make sure Unreal Engine editor is loaded loaded and running before running the server.
  • Check logs in unreal_mcp.log for detailed error information

Development

To add new tools, modify the UnrealMCPBridge.py file to add new command handlers, and update the unreal_mcp_server.py file to expose them through the HTTP API.