# Unreal Engine API Documentation [Health: Active]

**Category:** 🎮 Gaming  
**Repository:** https://github.com/Codeturion/unreal-api-mcp  
**GitHub Stars:** 100  
**Views:** 6  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/unreal-engine-api-documentation

## Description
Accurate UE5 C++ API docs for AI agents. Prevents hallucinated signatures and includes.

## Tools
Capabilities this server exposes over MCP:

- **search_unreal_api** — Search the Unreal Engine API by keyword.

    Args:
        query: Search terms (class name, function name, or keyword).
        n_results: Number of results to return (1-20, default 10).
        member_type: Filter by type: "class", "struct", "enum", "function",
                     "property", or "delegate". Leave empty for all.
    
- **get_function_signature** — Get the exact signature of an Unreal Engine function by fully-qualified name.

    Args:
        fqn: Fully-qualified name like "AActor::GetActorLocation" or
             "UGameplayStatics::SpawnActor".
    
- **get_include_path** — Get the #include path for an Unreal Engine class, struct, or type.

    Args:
        name: Class or type name (e.g. "AActor", "FHitResult", "ECollisionChannel").
    
- **get_class_reference** — Get all public members of an Unreal Engine class.

    Args:
        class_name: The class name (e.g. "AActor", "ACharacter", "UGameplayStatics").
    
- **get_deprecation_warnings** — Check if an Unreal Engine API is deprecated.

    Args:
        name: API name to check (function, class, property, etc.).
    

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `uvx` (confidence: high):

```json
"mcpServers": {
  "unreal-engine-api-documentation": {
    "command": "uvx",
    "args": ["unreal-api-mcp"],
    "env": {
      "UNREAL_VERSION": "",
      "UNREAL_PROJECT_PATH": ""
    }
  }
}
```

**Requires environment variables:** `UNREAL_VERSION`, `UNREAL_PROJECT_PATH` — the values above are empty placeholders; fill in real credentials before running (see the repository for what each one is for).

## Documentation

## What Unreal Engine API Documentation does

The Unreal Engine API Documentation MCP server provides AI agents with structured Unreal Engine C++ reference data. It covers Engine Runtime, Editor, and Developer modules, along with built-in plugins such as Enhanced Input, Gameplay Abilities, Common UI, Niagara, and Chaos. Blueprint graph internals are also indexed, including UK2Node subclasses and related graph and compiler modules.

The database contains classes, structs, enums, functions, properties, delegates, signatures, specifiers, member lists, documentation comments, and deprecation information. The available records depend on the selected Unreal Engine release, so answers can reflect changes between versions.

## How it works

The Unreal Engine API Documentation MCP server selects a database using `UNREAL_VERSION` first. If that variable is absent, it can read the `EngineAssociation` value from the project named by `UNREAL_PROJECT_PATH`. Without either setting, it uses Unreal Engine 5.7. A patch version can be requested, but the server falls back to its major-minor database when a matching patch database is unavailable.

On first use, the required SQLite database is downloaded from GitHub into `~/.unreal-api-mcp/`. The server also checks for updates at startup. Subsequent MCP requests query the version-specific local database. The documented measurements report sub-millisecond exact lookups, searches generally below 5 milliseconds, and higher latency for full class and deprecation queries.

## Setup and configuration

Run the package with `uvx` and set the version to match the project in the MCP client configuration:

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

No Unreal Engine installation is required. Supported database versions are listed in the project’s release information. Set `UNREAL_PROJECT_PATH` instead when the project file should determine the engine association.

## Tools and capabilities

The Unreal Engine API Documentation MCP server exposes five tools:

- `search_unreal_api` finds API records by keywords such as character movement or spawning actors.
- `get_function_signature` returns a function’s parameters and return type.
- `get_include_path` resolves the header needed for a type.
- `get_class_reference` returns a class reference with its indexed members.
- `get_deprecation_warnings` reports obsolete APIs and may identify a replacement.

These tools are useful for checking generated code before compiling, locating the correct header, examining a class surface, and avoiding APIs deprecated in the selected release.

## Limitations and notes

Coverage excludes third-party plugins and marketplace assets; consult project source for those APIs. Results are tied to the selected database, so the configured version should match the project. The included databases cover documented engine and built-in-plugin records rather than arbitrary source files in a project.

The project reports a large UE 5.7 index, including more than 10,000 classes, 9,000 structs, 3,400 enums, 23,000 functions, 66,000 properties, and 2,400 delegates. These counts describe that database and should not be treated as coverage for every Unreal release.

_Full upstream README: https://allmcps.com/mcp/unreal-engine-api-documentation/readme_

