# Unreal Engine API Documentation

Provides AI agents with exact Unreal Engine C++ signatures, #include locations, and deprecation details without installing the engine.

- MCP server · `type=mcp` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline, Zed, Gemini CLI · ★ 97
- Author: Codeturion
- License: MIT · policy=link-only · description only; the file stays with the author
- Source: https://github.com/Codeturion/unreal-api-mcp
- Updated: 2026-10-12
- HTML: https://affpapa.org/en/nevibecode/mcp/unreal-engine-api-documentation

## What it does

The server queries a local SQLite database compiled for specific engine releases. It determines the target version from the `UNREAL_VERSION` environment variable or the `EngineAssociation` property inside a `.uproject` file via `UNREAL_PROJECT_PATH`. UE 5.7 serves as the fallback whenever neither setting is passed. On its initial run, the tool fetches the database archive into `~/.unreal-api-mcp/`.

Five tools handle agent queries. They cover keyword searches with `search_unreal_api`, parameter lookup via `get_function_signature`, header resolution through `get_include_path`, class structure via `get_class_reference`, and deprecation status in `get_deprecation_warnings`. The index contains Runtime, Editor, Developer modules, and built-in plugins such as Niagara or Gameplay Abilities.

Third-party plugins and marketplace assets are omitted entirely from the database. For non-stock extensions, the agent must inspect local project files instead. Running the server requires Python 3.10 and `uvx`, though having Unreal Engine installed locally is unnecessary.

## Requirements
- Needs: Python and uv (commands run via uvx)
- Environment variables: `UNREAL_VERSION`, `UNREAL_PROJECT_PATH` — keys and tokens: ask the human for the values, never commit them or put them in shared files.
- Works with: Unreal Engine

## Install

### Claude Code (native platform)

**Platform CLI**
```bash
claude mcp add --env UNREAL_VERSION=<UNREAL_VERSION> --env UNREAL_PROJECT_PATH=<UNREAL_PROJECT_PATH> --transport stdio unreal-engine-api-documentation -- uvx unreal-api-mcp
```
Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from unreal-api-mcp <command>

### Codex

**Platform CLI**
```bash
codex mcp add unreal-engine-api-documentation --env UNREAL_VERSION=<UNREAL_VERSION> --env UNREAL_PROJECT_PATH=<UNREAL_PROJECT_PATH> -- uvx unreal-api-mcp
```
Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from unreal-api-mcp <command>

### Cursor

**Config file**
File `.cursor/mcp.json`:
```json
{
    "mcpServers": {
        "unreal-engine-api-documentation": {
            "command": "uvx",
            "args": [
                "unreal-api-mcp"
            ],
            "env": {
                "UNREAL_VERSION": "<UNREAL_VERSION>",
                "UNREAL_PROJECT_PATH": "<UNREAL_PROJECT_PATH>"
            }
        }
    }
}
```
Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from unreal-api-mcp <command>

### GitHub Copilot

**Config file**
File `.vscode/mcp.json`:
```json
{
    "servers": {
        "unreal-engine-api-documentation": {
            "type": "stdio",
            "command": "uvx",
            "args": [
                "unreal-api-mcp"
            ],
            "env": {
                "UNREAL_VERSION": "<UNREAL_VERSION>",
                "UNREAL_PROJECT_PATH": "<UNREAL_PROJECT_PATH>"
            }
        }
    }
}
```
Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from unreal-api-mcp <command>

### Gemini CLI

**Platform CLI**
```bash
gemini mcp add -e UNREAL_VERSION=<UNREAL_VERSION> -e UNREAL_PROJECT_PATH=<UNREAL_PROJECT_PATH> unreal-engine-api-documentation uvx unreal-api-mcp
```
Replace <…> with your own values. uvx runs the command named after the package; if the README names another one, use uvx --from unreal-api-mcp <command>

## When to use it
- locate the correct `#include` header for any engine class
- verify C++ function signatures and argument types
- identify deprecated Unreal Engine methods and their replacements
- inspect Blueprint graph internal classes and K2 nodes

## Example prompts
- Look up the exact `#include` path and method signature for AActor::GetActorLocation.
- Check if K2_AttachRootComponentTo is deprecated and show what replaces it.
- Search the Unreal API for character movement classes and their headers.

## Similar
- [Pascal 3D Editor](https://affpapa.org/en/nevibecode/mcp/pascal-3d-editor.md) — MCP server · ★ 25085
- [Unity-MCP](https://affpapa.org/en/nevibecode/mcp/unity-mcp.md) — MCP server · ★ 4523
- [mcp](https://affpapa.org/en/nevibecode/mcp/sceneview-mcp.md) — MCP server · ★ 1348
- [Gearboy MCP Server](https://affpapa.org/en/nevibecode/mcp/gearboy-mcp-server.md) — MCP server · ★ 1219
- [ChiR24-unreal_mcp_server](https://affpapa.org/en/nevibecode/mcp/chir24-unreal-mcp-server.md) — MCP server · ★ 975
- [Nova3D](https://affpapa.org/en/nevibecode/mcp/nova3d.md) — MCP server · ★ 733

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md