项目简介

UE-Editor-MCPServer 是一个虚幻引擎 (UE) 插件,它将 UE 编辑器转换为一个 Model Context Protocol (MCP) 服务器。该插件旨在使智能体 (Agent) 能够通过标准化的 MCP 协议与 UE 编辑器进行交互,从而实现自动化工作流程,例如内容创作、场景编辑、资源管理和构建流程自动化。

主要功能点

  • UE 编辑器 MCP 服务器: 将 UE 编辑器注册为一个 MCP 服务器,对外提供标准化的 MCP 接口。
  • 工具注册与调用: 允许注册和调用 UE 编辑器内的各种功能作为 MCP 工具,供 Agent 使用。目前提供示例工具,可扩展性强。
  • SSE 传输协议: 使用 Server-Sent Events (SSE) 作为 MCP 服务器的默认通信协议,实现与 MCP 客户端的实时通信。
  • Python 脚本扩展: 服务器逻辑主要通过 Python 脚本实现,方便用户自定义和扩展服务器功能及工具集。
  • UE 插件集成: 以 UE 插件形式提供,易于安装和集成到现有的 UE 项目中。

安装步骤

  1. 克隆仓库: 将 'UE-Editor-MCPServer' 仓库克隆到你的 UE 项目的 'Plugins' 目录下,或者 UE 引擎安装目录的 'Engine/Plugins' 目录下。
    git clone https://github.com/cc8887/UE-Editor-MCPServer.git
  2. 编译项目: 确保你的 UE 项目是 C++ 项目,然后在 UE 编辑器中编译项目。插件编译后,会在 UE 编辑器启动时自动加载。
  3. 检查 Python 依赖: 首次启动 UE 编辑器时,插件可能会自动安装 Python 依赖。请确保你的网络连接畅通,以便 pip 可以正常下载所需的 Python 包。

服务器配置

MCP 客户端需要配置连接到 UE 编辑器 MCP 服务器的信息。以下是一个典型的 JSON 格式配置示例,用于连接到本地运行的 UE 编辑器 MCP 服务器:

{
  "serverName": "UEEditorMCP",
  "command": "UEEditor",
  "args": [],
  "transport": "sse",
  "address": "http://127.0.0.1:8099/sse"
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,客户端可以自定义,用于标识不同的服务器连接。例如 "UEEditorMCP"。
  • 'command': 启动 MCP 服务器的命令。由于 UE 编辑器 MCP 服务器作为 UE 插件自动运行,客户端无需手动启动服务器,此项可以设置为 "UEEditor" 或任何占位符字符串。
  • 'args': 启动命令的参数列表。对于 UE 编辑器 MCP 服务器,此项通常为空数组 '[]',因为服务器伴随 UE 编辑器启动而启动,无需额外参数。
  • 'transport': MCP 服务器使用的传输协议,本插件默认为 "sse" (Server-Sent Events)。
  • 'address': MCP 服务器的 SSE 连接地址。默认情况下,UE 编辑器 MCP 服务器监听 'http://127.0.0.1:8099/sse' 地址。

基本使用方法

  1. 启动 UE 编辑器: 安装插件并编译项目后,启动 UE 编辑器。UE 编辑器 MCP 服务器会在编辑器启动后自动在后台运行。
  2. 配置 MCP 客户端: 在你的 MCP 客户端应用中,根据上述 “服务器配置” 示例,配置连接到 'http://127.0.0.1:8099/sse' 的 UE 编辑器 MCP 服务器。
  3. 连接与交互: MCP 客户端连接到服务器后,即可通过 MCP 协议发送请求,例如列出可用工具、调用特定工具等,与 UE 编辑器进行自动化交互。
  4. 扩展工具: 如果需要添加或修改 UE 编辑器提供的工具功能,可以编辑 'Content/Python/MCPServer.py' 文件中的 Python 代码,根据 MCP 协议规范添加或修改工具的定义和实现。

信息

分类

桌面与硬件