Unreal引擎AI助手连接服务

一个连接Epic Games Unreal AI助手的模型上下文协议服务器,提供文档查询、代码片段和蓝图指导功能。

  • by daniel-eder
  • JavaScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 daniel-eder/unreal-engine-assistant-mcp

使用说明

虚幻引擎助手MCP

连接到Epic Games的模型上下文协议(MCP)服务器 虚幻AI助手.

该服务器允许AI助手(如Claude、Cursor或任何兼容MCP的客户端)查询Epic的虚幻AI,并检索高度准确、最新的文档、C++代码片段和蓝图指南。它尊重Epic允许的内容(/allowed 终点)和速率限制(/check_limit 端点)。Puppeteer是用来避免反向发动机他们的API。

先决条件

  • Node.js(v18+)
  • 纱线(yarn set version stable)

安装

克隆此存储库并安装依赖项:

git clone https://github.com/daniel-eder/unreal-engine-assistant-mcp.git
cd unreal-engine-assistant-mcp
yarn install

用法

此服务器支持多种MCP传输方法:

1.标准(默认)

标准通信 stdout/stderr。这是Claude Desktop和Cursor等工具最常见的集成方法。

注: 由于此项目使用Yarn Zero Installs(PnP),您必须使用 yarn node 而不是标准 node 以解决依赖关系。

yarn node index.js

2.标准服务器发送事件(SSE)

启动本地web服务器,通过普通SSE处理上下文协议请求。

yarn node index.js --sse

默认情况下,它监听: http://127.0.0.1:3000/sse

(您可以通过传递来覆盖端口/主机 --port XXXX 和 --host XXXX例如。, yarn node index.js --sse --port 4000 --host localhost)

3.可流式传输HTTP

启动具有完整MCP Streamable HTTP会话支持的本地web服务器。

yarn node index.js --streamable-http

默认情况下,它监听: http://127.0.0.1:3000/mcp

(您可以通过传递来覆盖端口/主机 --port XXXX 和 --host XXXX例如。, yarn node index.js --streamable-http --port 4000 --host localhost)

发展

如果要在开发模式下运行服务器,只需使用中提供的脚本 package.json:

  • yarn start -通过标准stdio传输启动MCP服务器。
  • yarn start:sse -启动普通HTTP SSE服务器。
  • yarn start:streamable-http -启动MCP流式HTTP服务器。
  • yarn start:streamable-http --port 8080 --host localhost -使用自定义端口和主机启动HTTP服务器。

命令行参数

服务器接受几个命令行标志来自定义其行为:

参数 描述 默认值
--sse 使用普通服务器发送事件(SSE)传输运行服务器。适用于简单的HTTP集成。 (已禁用)
--streamable-http 使用具有会话支持的高级MCP Streamable HTTP传输运行服务器。 (已禁用)
--port <number> 覆盖绑定HTTP服务器时使用的端口(用于 --sse 和 --streamable-http). 3000
--host <string> 覆盖绑定HTTP服务器时使用的主机。使用 0.0.0.0 以暴露于本地网络 127.0.0.1
--delay <number> 调整无头浏览器在查询Epic的API之前等待Cloudflare验证所使用的睡眠持续时间(以毫秒为单位)。如果查询失败,请尝试增加此值。 2000

(如果未通过以下方式定义运输方式 --sse 或 --streamable-http,服务器默认为Stdio传输)

MCP客户端配置

将以下内容添加到您的mcp配置json中:

{
  "mcpServers": {
    "unreal-ai-assistant": {
      "command": "yarn",
      "args": [
        "node",
        "/path/to/your/unreal-engine-assistant-mcp/index.js"
      ]
    }
  }
}

可用工具

  • ask_unreal_engine_assistant -将您的问题发送到虚幻引擎助手,并返回结构化的markdown/HTML响应。接受单个字符串参数: question.

故障排除

  • Puppeter坠毁或无法发射:有时隐形插件需要系统库。如果在Linux上运行,请确保安装了标准的本地chromium依赖项。在Windows/Mac上,它通常是开箱即用的。
  • ARM/树莓派支持:Puppeteer捆绑的Chromium可能无法在ARM架构上开箱即用。要在Raspberry Pi或其他ARM设备上运行此项目:
    1. 安装原生Chromium浏览器: sudo apt-get install chromium-browser
    2. 服务器将自动尝试使用 /usr/bin/chromium-browser.
    3. 如果您的Chromium安装在其他位置,请设置 PUPPETEER_EXECUTABLE_PATH 在运行服务器之前的环境变量(例如。, export PUPPETEER_EXECUTABLE_PATH=/custom/path/to/chromium).
  • 初始请求延迟:当无头浏览器设置网站时,第一个问题可能需要几秒钟的时间https://dev.epicgames.com/community/assistant/unreal-engine.同一会话中的后续请求将快得多。你可以使用 --delay 以控制等待云耀斑验证时的人为延迟。

许可

版权所有(c)2026 Daniel Eder

此存储库中的所有内容都根据中找到的至少一个许可证进行许可 ./许可证;除非符合许可证,否则您不得使用此文件或此存储库中的任何其他文件。 您可以通过查看以下文件获得许可证的副本: ./许可证 文件夹。

除非适用法律要求或书面同意,否则根据许可证分发的软件按“原样”分发,不附带任何明示或暗示的保证或条件。请参阅 ./许可证 用于管理许可证下权限和限制的特定语言的文件夹。

该项目遵循 软件许可重用标准. 每个文件都包含版权和许可信息,许可文本可以在 ./许可证 文件夹。欲了解更多信息,请访问https://reuse.software/. 您可以在以下网址找到开发人员指南https://telekom.github.io/reuse-template/.