Unreal Engine API Documentation

unreal-api-mcp

为 AI Agent 提供准确的 Unreal Engine C++ API 文档的 MCP 服务。节省 token、上下文和时间，避免产生幻觉的函数签名、错误的 #include 路径以及使用已弃用的 API。

兼容 Claude Code、Cursor、Windsurf 以及任何兼容 MCP 的 AI 工具。无需安装 Unreal Engine。查看支持的版本。每周自动检测并构建新版本。

快速开始

将其添加到 MCP 配置（.mcp.json、mcp.json 或工具的 MCP 设置）中，并将 UNREAL_VERSION 设置为与你的项目相匹配的版本：

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

将此项设置为与你项目的 UE 版本相匹配。所有可用数据库请参阅支持的版本。

首次运行时，服务会将正确的数据库下载到 ~/.unreal-api-mcp/。如果没有对应补丁版本的数据库，补丁版本（例如 "5.7.3"）会回退到主次版本数据库（例如 "5.7"）。

工作原理

1. **版本检测。**服务会确定要提供哪个 UE 版本：

将其中一项设置为与你的项目相匹配。若两项都未设置，服务默认使用 UE 5.7。

2. **下载数据库。**如果该版本的数据库尚未缓存在本地，服务会从 GitHub 下载（仅需一次）。对于补丁版本，必要时会回退到主次版本数据库。服务也会在启动时检查更新。

3. **提供服务。**所有工具调用都会查询对应版本的 SQLite 数据库。精确查找耗时不到 1 毫秒，搜索耗时不到 5 毫秒。

每个版本都有独立的数据库，其中包含该版本对应的准确签名、弃用警告和成员列表。

工具

覆盖范围

涵盖所有引擎运行时、编辑器、开发者模块，以及内置插件（Enhanced Input、Gameplay Abilities、Common UI、Niagara、Chaos 等数百个插件）。

还包括 Blueprint 图表内部结构：158 个 UK2Node 子类、UEdGraphSchema_K2、BlueprintGraph、KismetCompiler 和 GraphEditor 模块（1,120 多条条目）。如果你正在编写自定义 K2 节点或编辑器工具，这些内容都已编入索引。

请在 db-v1 发布页面查看支持的版本和数据库完整列表。新版本会通过 CI 每周一自动检测并构建。

记录明细（UE 5.7）：

不涵盖第三方插件或市场资源。对于这些内容，请依赖项目源代码。

基准测试

实测结果，而非承诺：在 2 个测试环境中提出 14 个研究问题，由 3 种 Agent 配置作答，每个答案都根据事先核实的真实答案进行评判（API 事实对照文档数据库，源代码事实对照 UE 5.8 引擎源码树）。完整测试框架位于 docs/benchmark/，只需一条命令即可重新运行。

差距并不在你预想之处。对于文档完善的 include 和函数签名，以及 14,000 行引擎文件中可通过 grep 搜索到的实现事实，三种配置的表现不相上下。现代模型了解文档中记载的 UE 接口，也能熟练搜索本地源码。差距出现在近期弃用项上。当被问到 UKismetSystemLibrary::IsSplitScreen 在 5.8 中是否仍有效时，两个非 MCP Agent 都答错了：一个拒绝回答，另一个断言它仍可用。实际上，它已弃用，应改用 HasMultipleLocalPlayers。两者也都错误描述了 5.5 时代的一项变更：直接访问 AActor::NetUpdateFrequency 已被弃用。MCP Agent 正确回答了全部三个弃用问题，因为数据库中记录了弃用标记和替代项提示。

为什么关注正确性，而不是原始输出？如今，Agent 工具已经很擅长搜索代码。Claude Code 从一开始就提供了 Grep 工具，因此 Agent 能找到文件中实际存在的任何内容。问题在于文件中不存在的信息：精确签名、#include 路径，尤其是最新的弃用项。这些信息也不可靠地存在于模型记忆中，答错一个就可能导致构建失败，或悄悄使用已弃用的调用。

CLAUDE.md 片段

将以下内容添加到项目的 CLAUDE.md（或同等说明文件）中。**这一步很重要。**否则，AI 虽然有这些工具，却不知道何时该使用它们。

## Unreal Engine API Lookup (unreal-api MCP)

Use the `unreal-api` MCP tools to verify UE C++ API usage instead of guessing. **Do not hallucinate signatures or #include paths.**

| When | Tool | Example |
|------|------|---------|
| Unsure about a function's parameters or return type | `get_function_signature` | `get_function_signature("AActor::GetActorLocation")` |
| Need the `#include` for a type | `get_include_path` | `get_include_path("ACharacter")` |
| Want to see all members on a class | `get_class_reference` | `get_class_reference("UCharacterMovementComponent")` |
| Searching for an API by keyword | `search_unreal_api` | `search_unreal_api("spawn actor")` |
| Checking if an API is deprecated | `get_deprecation_warnings` | `get_deprecation_warnings("K2_AttachRootComponentTo")` |
| Writing custom K2 nodes or editor tools | `get_class_reference` | `get_class_reference("UK2Node_SpawnActorFromClass")`, `get_class_reference("UEdGraphSchema_K2")` |

**Rules:**
- Before writing a UE API call you haven't used in this conversation, verify the signature with `get_function_signature`
- Before adding a `#include`, verify with `get_include_path` if unsure
- Covers: all Engine Runtime/Editor modules, built-in plugins (Enhanced Input, GAS, CommonUI, Niagara, etc.), Blueprint graph internals (UK2Node subclasses, EdGraphSchema, BlueprintGraph, KismetCompiler)
- Does NOT cover: third-party plugins or marketplace assets

设置详情

{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_PROJECT_PATH": "F:/Unreal Projects/MyProject"
      }
    }
  }
}

pip install unreal-api-mcp

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

# Build for a specific version
python -m unreal_api_mcp.ingest --unreal-version 5.6 --unreal-install "H:/UE_5.6"
python -m unreal_api_mcp.ingest --unreal-version 5.5 --unreal-install "H:/UE_5.5"

unreal-api-mcp/
├── src/unreal_api_mcp/
│   ├── server.py          # MCP server (5 tools)
│   ├── db.py              # SQLite + FTS5 database layer
│   ├── version.py         # Version detection + DB download
│   ├── header_parser.py   # Parse Unreal C++ headers (UCLASS, UFUNCTION, etc.)
│   ├── unreal_paths.py    # Locate UE installs + discover modules
│   └── ingest.py          # CLI ingestion pipeline
└── pyproject.toml

故障排除

另请参阅

unity-api-mcp：Unity（C#）的同类工具。涵盖 Unity 2022、2023 和 Unity 6。

联系方式

需要为你的引擎或框架定制 MCP 服务吗？我会构建 MCP 工具，减少令牌浪费，并防止 AI 辅助游戏开发中的幻觉。如果你希望为团队的技术栈构建类似工具，欢迎联系我。

[email protected]

许可证

MIT

可免费用于任何个人或非商业用途，包括使用、派生、修改和分享。 商业用途需要获得许可。