unreal-api

The unreal-api MCP server provides AI-assisted Unreal Engine C++ API lookups by querying a version-specific SQLite database. It offers tools to search APIs by keyword, retrieve exact function signatures, resolve include paths for types, obtain full class references, and check for deprecations. By configuring UNREAL_VERSION (or letting the server detect from your project), you can ensure the agent receives accurate, version-appropriate data, reducing hallucinations and incorrect includes. The server is designed to work with Claude Code, Cursor, Windsurf, or any MCP-compatible AI tool, and it automatically downloads and caches the correct database for the chosen UE version on first run.

Prerequisites:\n- Python 3.10+ installed on your system.\n- git and a working network connection.\n- An MCP client or toolchain that can consume MCP servers (e.g., Claude Code, Cursor, Windsurf).\n\nInstallation steps:\n1) Install Python dependencies (if provided by the project, usually via pip):\nbash\npip install unreal-api-mcp\n\n2) Install or run the MCP server entry point using uvx (as shown in the configuration):\nbash\nuvx unreal-api-mcp\n\n3) Configure your MCP client to point at the server using the mcp_config example (adjust UNREAL_VERSION as needed). For local development, you can set the environment variable UNREAL_VERSION to the target UE version (e.g., 5.5).\n4) Start the server and verify the tools are responding (e.g., run a quick test query like get_function_signature for AActor::GetActorLocation).\n\nNotes:\n- The server downloads databases to ~/.unreal-api-mcp/ on first run. Patch versions try major.minor databases if a patch-specific one isn’t available.\n- Ensure UNREAL_VERSION matches your project to get accurate results.\n

Tips and common issues:\n- If UNREAL_VERSION is not set, the server defaults to UE 5.7. Set UNREAL_VERSION to a value like 5.5 or 5.7 to target a specific database.\n- The database is version-specific; always use a matching UE version to avoid signature mismatches.\n- Check for updates on startup to ensure you have the latest signatures and deprecations.\n- For large projects, consider caching strategy and disk space management since databases can be sizable.\n- If you encounter missing includes or signatures, confirm you’re querying the correct class/type name and that the UE version database contains that symbol.\n