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 或有建議？提交一個問題。