← 返回目录
U

Unreal Engine API Documentation MCP Server

社区
为 AI 代理提供准确、即时的虚幻引擎 C++ API 查询,节省 token 并避免签名幻觉。
GitHub 源仓库 ↗
★ 95 Stars 分类 · 开发工具 热门
52FMRS · D

这是一个面向虚幻引擎 C++ 开发者的实用 MCP 服务器,核心价值在于用数据库查询替代昂贵的源码阅读与模型记忆,显著降低签名幻觉、include 路径错误和弃用 API 使用。基准测试显示,在最新弃用信息这类模型记忆不可靠的问题上,使用该 MCP 的代理明显优于仅靠 Grep/Read 或纯阅读的配置。适合在 Claude Code、Cursor、Windsurf 等环境中编写 UE5 C++ 的开发者;但它不覆盖第三方插件与商城资源,且属第三方项目而非 Epic 官方,首次运行依赖网络下载数据库。

可靠性
8/20
安全与权限
9/20
维护活跃度
10/20
文档质量
13/20
安装易用性
12/20
查看 FMRS 评分方法 →

这是一个基于 Model Context Protocol 的 MCP 服务器,为 AI 编程代理提供准确的虚幻引擎(Unreal Engine)C++ API 文档查询能力。它通过查询版本专属的 SQLite 数据库来返回精确的函数签名、#include 路径、类成员列表和弃用警告,从而避免代理凭空编造签名、写错头文件路径或使用已弃用的 API。首次运行时会自动下载对应引擎版本的数据库到 ~/.unreal-api-mcp/ 目录,之后通过 stdio 传输提供服务,无需安装虚幻引擎本体。覆盖引擎 Runtime、Editor、Developer 模块以及内置插件(如 Enhanced Input、Gameplay Abilities、Common UI、Niagara、Chaos 等),并索引了 Blueprint 图内部结构(158 个 UK2Node 子类、UEdGraphSchema_K2、BlueprintGraph、KismetCompiler、GraphEditor)。不覆盖第三方插件或商城资源。许可证为 MIT,商业用途需获得授权。

工具能力

search_unreal_api
按关键词查找 API,例如 "character movement"、"spawn actor"、"K2Node"。
get_function_signature
获取包含参数与返回类型的精确函数签名,例如 AActor::GetActorLocation。
get_include_path
解析某个类型所需的 #include 路径,例如 "ACharacter" 对应 #include "GameFramework/Character.h"。
get_class_reference
返回完整的类参考卡片,例如 "APlayerController"、"UK2Node_SpawnActorFromClass"、"UEdGraphSchema_K2"。
get_deprecation_warnings
检查某个 API 是否已弃用,例如 K2_AttachRootComponentTo 建议改用 AttachToComponent()。

安装接入

  1. 在你的 MCP 配置文件中(如 .mcp.json、mcp.json 或所用工具的 MCP 设置)添加服务器配置。
  2. 使用 uvx 作为命令:command 为 "uvx",args 为 ["unreal-api-mcp"]。
  3. 通过环境变量 UNREAL_VERSION 指定与你项目一致的引擎版本(如 "5.5"),或用 UNREAL_PROJECT_PATH 指向项目目录以从 .uproject 的 EngineAssociation 字段自动检测版本。
  4. 首次运行时,服务器会自动把对应版本的数据库下载到 ~/.unreal-api-mcp/。
  5. 建议在项目的 CLAUDE.md 或等效说明文件中加入使用规则,提示 AI 在写 UE API 调用前先验证签名和 include 路径。
  6. 备选安装方式:pip install unreal-api-mcp,然后把 command 改为 "unreal-api-mcp"。
claude_desktop_config.json
{
  "mcpServers": {
    "unreal-api": {
      "command": "uvx",
      "args": ["unreal-api-mcp"],
      "env": {
        "UNREAL_VERSION": "5.5"
      }
    }
  }
}

选型与风险

适合谁

  • 使用 AI 代理编写虚幻引擎 C++ 代码的开发者
  • 希望减少 token 消耗、避免 API 幻觉的团队
  • 需要处理最新弃用警告与版本差异的 UE5 项目
  • 在 Claude Code、Cursor、Windsurf 等 MCP 兼容工具中工作的开发者

不适合谁

  • 需要查询第三方插件或商城资源 API 的用户(未被索引)
  • 使用非虚幻引擎技术栈的项目
  • 需要图形界面而非代理工具查询文档的用户
  • 需要官方 Epic Games 支持与背书的用户

所需权限

  • 读取本地文件系统:用于从 .uproject 自动检测引擎版本,并在 ~/.unreal-api-mcp/ 读写数据库缓存
  • 网络访问:首次运行及启动时从 GitHub 下载对应版本的数据库并检查更新

风险与副作用

  • 首次运行需联网下载数据库,网络受限环境可能失败
  • 若未设置 UNREAL_VERSION 或 UNREAL_PROJECT_PATH,可能默认使用与实际项目不符的引擎版本,从而给出错误版本的 API
  • 仅覆盖引擎与内置插件,第三方插件查询会返回空结果,可能误导代理认为某 API 不存在
  • 该服务器由第三方开发者维护,非 Epic Games 官方项目,不提供官方支持
  • 许可证虽为 MIT,但商业用途需额外获得授权

常见排障

  1. 提示 "Could not download UE X database":检查网络连接,或在本地用 python -m unreal_api_mcp.ingest --unreal-version 5.6 --unreal-install H:/UE_5.6 自行构建数据库
  2. 服务了错误版本的 API:显式设置 UNREAL_VERSION,并查看 stderr 中的 "unreal-api-mcp: serving UE <version>" 确认
  3. 服务器无法启动:检查 python --version 是否为 3.10+,并用 which unreal-api-mcp 或 where unreal-api-mcp 确认路径
  4. 第三方插件查询无结果:这是预期行为,仅索引了内置引擎与插件 API

使用场景

在编写虚幻引擎 C++ 代码时验证函数签名、参数与返回类型
确认某个类型应使用哪个 #include 头文件路径
查看某个类(如 UCharacterMovementComponent)的全部成员
按关键词检索引擎 API,例如查找 "spawn actor" 相关接口
检查某个 API 是否已弃用及其替代方案
编写自定义 K2 节点或编辑器工具时查询 Blueprint 图内部结构

支持客户端

Claude Code完整支持
Cursor完整支持
Windsurf完整支持