Unrealengine5 MCP

🚀 Unreal Engine MCP

MCP 工具可实现对 Unreal Engine 5.6+ 的自然语言控制。专为大型项目设计，支持专业的蓝图工作流程。可通过 MCP 客户端构建节点图、创建游戏玩法能力并自动化编辑器任务。还包含由检索增强生成（RAG）驱动的 Python 脚本编写功能，可查阅 Unreal Python API 文档。

🚀 快速开始

要求

⚠️ 重要提示

建议使用 uv 包管理器，若未安装，系统将自动安装。

1. 克隆仓库

git clone https://github.com/gimmeDG/UnrealEngine5-mcp.git
cd UnrealEngine5-mcp

2. 设置 Unreal Engine 插件

1. 将 Plugins/UnrealEngineMCP 文件夹复制到你的 Unreal 项目的 Plugins/ 目录下。
2. 在 Unreal 编辑器中打开你的项目。
3. 启用插件：编辑 → 插件 → 搜索 "UnrealEngineMCP" → 启用。
4. 重启 Unreal 编辑器。

3. 配置 MCP 客户端

Claude Desktop

Windows - 编辑 %APPDATA%\Claude\claude_desktop_config.json：

{
  "mcpServers": {
    "UnrealEngineMCP": {
      "command": "uv",
      "args": [
        "--directory",
        "C:\\path\\to\\unreal-engine-mcp",
        "run",
        "main.py"
      ]
    }
  }
}

macOS - 编辑 ~/Library/Application Support/Claude/claude_desktop_config.json：

{
  "mcpServers": {
    "UnrealEngineMCP": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/unreal-engine-mcp",
        "run",
        "main.py"
      ]
    }
  }
}

Cursor

设置 → MCP → 添加服务器，使用相同的配置：

{
  "UnrealEngineMCP": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/unreal-engine-mcp",
      "run",
      "main.py"
    ]
  }
}

4. （可选）环境设置

cp .env.example .env
# 若需要更改默认设置，请编辑 .env

默认配置可直接使用。服务器将：

• 自动创建虚拟环境。
• 安装所有依赖项。
• 在首次运行时生成 BM25 索引。

✨ 主要特性

🎬 演示

寻的集束手榴弹 - Lyra 手榴弹 + MCP 生成的蓝图（GA，技能系统）

📚 详细文档

可用工具

编辑器工具（21 个工具）

蓝图工具（47 个工具）

RAG 工具（2 个工具）

PCG 工具（13 个工具） - 早期阶段

⚠️ 重要提示

PCG 工具已具备功能，但仍在优化中。

🔧 技术细节

┌─────────────────────────────────────────────────────────────┐
│              Claude Desktop / Cursor (Client)                │
│            LLM reasoning & tool invocation                   │
└──────────────────────────┬──────────────────────────────────┘
                           │ MCP Protocol (stdio)
┌──────────────────────────┴──────────────────────────────────┐
│                    Python MCP Server                         │
│  ┌────────────────────────────────────────────────────────┐ │
│  │ Tools                                                  │ │
│  │  • editor_tool    - Actor/asset manipulation           │ │
│  │  • blueprint_tool - Blueprint/GAS node graphs          │ │
│  │  • pcg_tool       - PCG graph construction             │ │
│  │  • rag_tool       - API search & Python execution      │ │
│  └────────────────────────────────────────────────────────┘ │
└──────────────────────────┬──────────────────────────────────┘
                           │ TCP
┌──────────────────────────┴──────────────────────────────────┐
│                 Unreal Engine C++ Plugin                     │
│  ┌────────────────────────────────────────────────────────┐ │
│  │ Command Handlers                                       │ │
│  │  • EditorCommands    - Level actor operations          │ │
│  │  • BlueprintCommands - BP asset & node graph editing   │ │
│  │  • PCGCommands       - PCG graph manipulation          │ │
│  │  • PythonExecutor    - Python script execution         │ │
│  └────────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘

RAG System (BM25):
  • Provides Unreal Python API documentation search
  • Used by execute_unreal_python on failure for error recovery
  • No external API keys required

📄 许可证

本项目采用 MIT 许可证。

💬 反馈

发现了 bug 或有建议？提交一个问题。