Unreal Engine API Documentation MCP Server

社区

为 AI 代理提供准确、即时的虚幻引擎 C++ API 查询，节省 token 并避免签名幻觉。

分类: 开发工具第 227 / 438
Stars: ★ 96 热门
传输方式: stdio（本地进程）
运行环境: Python 3.10+
凭据: 无需凭据
许可证: MIT
最近提交: 13 天前
工具数: 5

52FMRS · D

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

最强项 · 文档质量 13/20 最弱项 · 可靠性 8/20

可靠性

8/20

安全与权限

9/20

维护活跃度

10/20

文档质量

13/20

安装易用性

12/20

查看各项评分依据

可靠性 8/20: 静态证据只能确认 README、server.json 与项目结构描述：5 个工具（search_unreal_api、get_function_signature、get_include_path、get_class_reference、get_deprecation_warnings）与描述一致，运行路径（uvx/pip、stdio、首次下载数据库到 ~/.unreal-api-mcp/）叙述清楚，并附有延迟与基准表。但未提供任何可核验的执行证据：无提交的测试、无 CI 工作流文件内容（README 仅引用 detect-ue-release 徽章）、无错误处理代码可读，因此按静态校准上限只给 8。版本回退（patch -> major.minor）、默认 5.7/5.8 说法在 README 内部并不完全一致（描述写默认 5.8，正文写默认 5.7），属于矛盾之处，进一步扣分。
安全与权限 9/20: 未发现红线行为：无凭据采集、无静默外传、无危险默认操作；工具为只读查询，网络访问限于从 GitHub 下载 SQLite 数据库并检查更新，环境变量均为非密文字符串（UNREAL_VERSION/UNREAL_PROJECT_PATH/UNREAL_INSTALL_PATH）。扣分点在于：首次启动自动联网下载并写入用户主目录，README 未披露下载源的具体完整性校验（如哈希/签名）、未说明更新检查频率与失败策略，也未提供禁用网络或离线模式的开关；ingest 可读取本地引擎路径但未声明写入范围。权限与数据边界基本可见但不完整，故 9 分，未触及红线。
维护活跃度 10/20: 仓库未归档，MIT 许可存在，README 显示声称的每周自动版本检测与数据库重建流程、db-v1 发布页与基准复跑脚本路径，另有 PyPI 徽章和联系方式邮箱。扣分：无法从静态材料核实 CI 工作流真实存在或其行为（徽章非证据）；版本号仅 0.1.1，治理信息（变更日志、安全响应渠道、依赖更新策略、issue 响应记录）缺失；样本仅 95 stars、1 open issue，活跃度信号有限且不计分。另注意许可正文写“商业使用需授权”，与 MIT 徽章存在潜在表述冲突，影响治理清晰度。综合判 10。
文档质量 13/20: 文档分层较好：快速开始、版本检测优先级表、5 个工具表格与示例、覆盖范围与明确的不覆盖声明（第三方插件/商城资源不含）、记录数量统计、性能延迟表、基准方法与可复跑命令、CLAUDE.md 使用片段、故障排查表和备用安装方式，安装与参数说明具体。扣分：默认版本说法自相矛盾（5.7 vs 5.8）；每个工具缺少完整参数签名与返回结构说明；基准结果由作者自测且图像托管在 raw 链接，无法静态核验；数据库校验/更新行为、隐私与网络数据流未披露；成本与限制（尤其许可中商业使用限制与 README“免费使用”表述）未澄清。故 13。
安装易用性 12/20: 配置示例完整（uvx 与 pip 两种方式、stdio、env 注入 UNREAL_VERSION 或 UNREAL_PROJECT_PATH），并提供 .uproject 自动检测与本地 ingest 备选路径，主流客户端（Claude Code/Cursor/Windsurf）描述清楚，Python 3.10+ 要求明确。但无提交的测试或 CI 证据证明安装后端到端可用，且首次运行需联网下载数据库、写入主目录，失败场景与离线路径需自行处理，属于中等手动/易受干扰的安装流程。按静态校准上限 15，实给 12。

静态评测 · 未实际运行收录于 2026-09-10

查看 FMRS 评分方法 →

选型与风险

能访问什么访问网络连接数据库

适合谁

使用 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，但商业用途需额外获得授权

安装接入

准备工作

运行环境：Python 3.10+

其他可选配置项（3 个）

UNREAL_VERSION 可选要提供文档的 Unreal Engine 版本，如 5.5 或 5.7.3，自行设置；不设则默认 5.7（或经 UNREAL_PROJECT_PATH 自动检测）。

UNREAL_PROJECT_PATH 可选本地 Unreal 项目路径，服务器会读取 .uproject 的 EngineAssociation 字段自动检测版本。

UNREAL_INSTALL_PATH 可选仅在本地用 ingest 构建数据库时覆盖 UE 安装路径（如 H:/UE_5.6），正常运行无需设置。

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

.mcp.json

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

以 Claude Code 为例。其他客户端的配置文件位置或字段可能不同（如 VS Code 使用 servers 字段），可用下方配置生成器转换。

.vscode/mcp.json

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

写入项目的 .vscode/mcp.json（VS Code 使用 servers 字段）。

Terminal

claude mcp add unreal-api -e UNREAL_VERSION=5.5 -- uvx unreal-api-mcp

在终端运行；先把 <…> 占位符换成你自己的值。

生成并校验客户端配置

验证是否装好

启动后检查客户端工具列表中是否出现 search_unreal_api、get_function_signature、get_include_path、get_class_reference、get_deprecation_warnings 这五个工具；也可用 get_function_signature("AActor::GetActorLocation") 验证数据库已下载并能正常查询。stderr 中应显示 unreal-api-mcp: serving UE <version>。

常见排障

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

试试这样问

连接成功后，可以直接对 AI 助手这样说：

AActor::GetActorLocation 的完整函数签名是什么？
ACharacter 的 #include 路径是什么？
搜索与 character movement 相关的 Unreal Engine API。
K2_AttachRootComponentTo 是否已被弃用？如果是，推荐用什么替代？

工具能力 5

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()。

使用场景

在编写虚幻引擎 C++ 代码时验证函数签名、参数与返回类型

确认某个类型应使用哪个 #include 头文件路径

查看某个类（如 UCharacterMovementComponent）的全部成员

按关键词检索引擎 API，例如查找 "spawn actor" 相关接口

检查某个 API 是否已弃用及其替代方案

编写自定义 K2 节点或编辑器工具时查询 Blueprint 图内部结构

支持客户端

Claude Code

Cursor

Windsurf

依据项目文档列出，未经本站实测。

详细介绍

这是一个基于 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，商业用途需获得授权。