Back to MCP directory
publicPublicdnsLocal runtime

UnrealMCPBridge

这是一个Unreal Engine插件,实现了Model Context Protocol (MCP)服务端,允许MCP客户端(如Claude)通过Python API访问Unreal Engine的全部功能。

article

README

🚀 虚幻引擎 MCP Python 桥接插件

这是一款专为虚幻引擎(UE)打造的插件,它实现了 Model Context Protocol (MCP) 的服务器端。借助该插件,像 Anthropic 的 Claude 这类 MCP 客户端能够访问完整的 UE Python API,开启更高效的开发体验。

🚀 快速开始

本插件可助力开发者在 Python 中开发工具和工作流,并借助类似 Claude 的智能体实现自动化,还能实现工作流的智能与动态自动化,以及与智能体协作开展通用协作式开发。

✨ 主要特性

  • 跨工具协作:允许使用像 Claude 这样的 MCP 客户端访问完整的 UE Python API,实现不同工具间的协作开发。
  • 自动化开发:支持在 Python 中开发工具和工作流,并通过智能体进行自动化,提高开发效率。
  • 动态工作流:实现工作流的智能和动态自动化,让开发过程更加灵活。
  • 协作式开发:与智能体协作进行通用协作式开发,促进创新和高效合作。

📦 安装指南

从 Fab 安装

最便捷的安装方式是从 Fab 商店页面 安装 MCP Python 桥接插件。购买完成后,插件会出现在 Epic Games 启动器的库中。您只需点击“安装到虚幻引擎”,然后依照提示完成安装即可。

从 GitHub 安装

若无法通过 Fab 安装,您可以从 GitHub 下载源代码并手动构建:

  1. 访问 GitHub 仓库
  2. 将仓库克隆到本地开发环境。
  3. 打开 Visual Studio 2019 或更高版本,然后打开项目文件夹中的 .uproject 文件。
  4. 点击“构建”以生成插件。

💻 使用示例

基础用法

要在 unreal_mcp_client.py 中添加新的工具和提示,只需遵循现有的模式。例如,以下是如何在客户端中定义一个名为 create_castle() 的新提示:

@mcp.prompt()
def create_castle() -> str:
    """创建一座城堡"""
    return f"""
请在当前虚幻引擎项目中创建一座城堡。
0. 参考虚幻引擎 Python API 以查找创建新代码的文档:https://dev.epicgames.com/documentation/en-us/unreal-engine/python-api/?application_version=5.5
1. 清理场景中的所有 StaticMeshActors。
2. 获取项目目录和内容目录。
3. 找到构建结构的基本形状。
4. 使用这些基本形状创建一座城堡。
"""

每次修改 unreal_mcp_client.py 后,必须重启 Claude 以使更改生效。在 Windows 上,可能需要通过任务管理器结束 Claude 进程才能完全重启。

开发提示

通过遵循上述步骤,您可以轻松地将新的工具和提示集成到 MCP Python 桥接插件中,并扩展与 Claude 的交互能力。

📚 详细文档

先决条件

  • Visual Studio 2019 或更高版本(如果从代码构建)。
  • 一个 AI 智能体。以下假设使用 Claude,但任何实现 MCP 的 AI 智能体均可使用。
  • 启用 Python 编辑器脚本插件的虚幻引擎 5。
  • 注意 虚幻引擎 Python API
help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client