Unreal API

v0.2.0Developer Toolsstable

Instant, accurate Unreal Engine API lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations.

aiapi-documentationclaudecppcursor
Share:
77
Stars
0
Downloads
0
Weekly
0/5

What is Unreal API?

Unreal API is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to instant, accurate unreal engine api lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations.

Instant, accurate Unreal Engine API lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations.

This server falls under the Developer Tools category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • Instant, accurate Unreal Engine API lookups instead of expen

Use Cases

Unreal Engine API documentation access
Token-efficient API lookups
Game development support
Codeturion

Maintainer

LicenseNOASSERTION
Languagepython
Versionv0.2.0
UpdatedMay 18, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

PIP

pip install unreal-api-mcp

Manual Installation

pip install unreal-api-mcp

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Unreal API

unreal-api-mcp is a Python-based MCP server that gives AI coding assistants instant, accurate access to Unreal Engine C++ API documentation — covering over 114,000 records including classes, structs, enums, functions, properties, and delegates across Engine Runtime, Editor, Developer modules, and built-in plugins like Enhanced Input, Gameplay Abilities, Niagara, and Chaos. Instead of having the AI read source files (which wastes thousands of tokens and risks hallucinated signatures), the server queries a local SQLite database derived from official UE headers, returning exact function signatures, correct #include paths, class member lists, and deprecation warnings in under 25ms. It requires no Unreal Engine installation and automatically downloads the correct database for your project's UE version on first run.

Prerequisites

  • Python 3.10 or later (or uv/uvx for zero-install usage)
  • An MCP-compatible client such as Claude Desktop, Cursor, or Windsurf
  • An Unreal Engine project (to know your target UE version — e.g. 5.5, 5.7)
  • Internet access for the one-time database download (~several MB per version)
1

Identify your Unreal Engine version

Check your .uproject file's EngineAssociation field to find the exact UE version used by your project. You will pass this as the UNREAL_VERSION environment variable (e.g. '5.5' or '5.7'). Alternatively, set UNREAL_PROJECT_PATH to your project folder and the server auto-reads the version.

2

Install via pip (or use uvx for zero-install)

Install the package globally with pip, or skip installation entirely by using uvx in your MCP config which downloads and runs the package on demand.

pip install unreal-api-mcp
3

Add to your MCP client configuration

Add the unreal-api entry to your MCP config file. Set UNREAL_VERSION to match your project. On first run the server downloads the version-specific database to ~/.unreal-api-mcp/ automatically.

{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_VERSION": "5.5"
      }
    }
  }
}
4

Alternative: point to your project directory

Instead of hardcoding a version, set UNREAL_PROJECT_PATH to your project root. The server reads the EngineAssociation field from your .uproject file to determine the correct database version automatically.

{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_PROJECT_PATH": "/path/to/MyUnrealProject"
      }
    }
  }
}
5

Add a CLAUDE.md snippet to your project

To ensure the AI reaches for the tools proactively, add usage instructions to your project's CLAUDE.md (or equivalent context file). Without this, the AI may try to read source files instead of querying the MCP server.

## Unreal Engine API Lookup (unreal-api MCP)
Use the unreal-api MCP tools to verify UE C++ API usage.
- get_function_signature: verify parameters and return type before writing a call
- get_include_path: resolve the correct #include for any type
- get_class_reference: list all members of a class
- search_unreal_api: find APIs by keyword
- get_deprecation_warnings: check if an API is obsolete
6

Verify the server is working

Restart your MCP client and ask it to look up a well-known UE function. The server should return the exact signature without hallucinating parameters.

Unreal API Examples

Client configuration

Using uvx for zero-install setup with UE 5.5 database. Replace 5.5 with your project's UE version.

{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_VERSION": "5.5"
      }
    }
  }
}

Prompts to try

Practical prompts for Unreal Engine C++ development with the API lookup server active.

- "What are the parameters and return type of AActor::GetActorLocation?"
- "What #include do I need to use ACharacter?"
- "Show me all public members of UCharacterMovementComponent"
- "Search the Unreal API for functions related to spawning actors"
- "Is K2_AttachRootComponentTo deprecated? What should I use instead?"
- "Find all UFunction entries related to Enhanced Input"

Troubleshooting Unreal API

Server fails to start with a database download error

Check your internet connection — the server downloads the SQLite database from GitHub Releases on first run. If the exact patch version (e.g. 5.5.3) is not available, set UNREAL_VERSION to the major.minor only (e.g. '5.5'). Downloaded databases are cached at ~/.unreal-api-mcp/.

Wrong UE version database is loaded

Verify UNREAL_VERSION matches the EngineAssociation in your .uproject file exactly. Alternatively switch to UNREAL_PROJECT_PATH pointing to your project folder so the server auto-reads the version. Without either env var, the server defaults to UE 5.7.

AI ignores the MCP tools and reads source files instead

Add the CLAUDE.md snippet from the project README to your project's context file. Explicit instructions to use specific tools before writing UE API calls are required to override the AI's default behavior of searching the filesystem.

Frequently Asked Questions about Unreal API

What is Unreal API?

Unreal API is a Model Context Protocol (MCP) server that instant, accurate unreal engine api lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations. It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Unreal API?

Install via pip with: pip install unreal-api-mcp. Then configure your AI client to connect to this MCP server.

Which AI clients work with Unreal API?

Unreal API works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Unreal API free to use?

Yes, Unreal API is open source and available under the NOASSERTION license. You can use it freely in both personal and commercial projects.

Browse More Developer Tools MCP Servers

Explore all developer tools servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "unreal-api": { "command": "pip", "args": ["install", "unreal-api-mcp"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use Unreal API?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides