Before running the Unreal MCP Web Client, ensure your environment meets the requirements listed below — covering the Unreal Engine version, operating system, Python runtime, required plugins, and network ports.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/davidbuenov/dbv-mcp-server/llms.txt
Use this file to discover all available pages before exploring further.
Unreal Engine
- Version: 5.8 or later
- Project type: C++ project (Blueprint-only projects cannot link the additional
Build.csdependencies required by some toolset plugins) - The built-in MCP server ships with UE 5.8 — no separate install is needed
Operating System
Windows, macOS, and Linux are all supported. The start/stop scripts (start.sh / stop.sh for macOS/Linux, start.cmd / stop.cmd for Windows) handle platform differences automatically.
Python
- Version: Python 3.x — Python 3.12 is recommended for best compatibility with
asyncioand type-annotation features used inserver.py - Confirm Python is on your
PATHby runningpython --versionin a terminal
Required packages
Install with a single command:| Package | Purpose |
|---|---|
fastapi | ASGI web framework that powers the proxy server and REST endpoints |
uvicorn | ASGI server that runs the FastAPI application |
httpx | Async HTTP client used to forward requests from the proxy to Unreal’s MCP server |
Optional packages (guide crawling only)
playwright is only required if you want to crawl or update the local conceptual guides knowledge base (scrape_ue_guides.py). The Chromium browser is needed to bypass Cloudflare Bot Management on Epic’s documentation portal. It is not needed for any normal proxy or agent workflow.
Required Unreal Engine Plugins
Enable these in your.uproject Plugins array. See the Quickstart for the exact JSON snippet.
| Plugin Name | Purpose | Required? |
|---|---|---|
ModelContextProtocol | Starts the built-in MCP server on port 8000 | Required |
ToolsetRegistry | Toolset registry subsystem — manages toolset discovery and list_toolsets / describe_toolset | Required |
MCPClientToolset | Exposes the core call_tool MCP tool used by all agent calls | Required |
PythonScriptPlugin | Enables Python scripting inside Unreal Engine so RunPython tool calls work | Required |
EditorToolset | Adds 100+ editor tools covering viewport, scene, assets, Blueprints, and materials | Strongly recommended |
AutomationTestToolset | Discover and run Unreal automation tests via MCP tool calls | Optional |
SlateInspectorToolset | UI interaction tools — mouse clicks, widget snapshots, Slate tree inspection | Optional |
Network Ports
| Port | Service | Notes |
|---|---|---|
| 8000 | Unreal Engine MCP server | Opened automatically when Auto Start Server is enabled |
| 5000 | Local FastAPI proxy (server.py) | Started by start.sh / start.cmd |
The proxy must run on localhost. Unreal’s built-in MCP server only accepts connections from
localhost or 127.0.0.1 — requests originating from any other address or hostname will be refused. Do not attempt to expose port 8000 on an external network interface.