JinDaGe - unreal-mcp MCP Details

article

README

🚀 unreal - mcp

unreal - mcp 是一款适用于虚幻引擎（Unreal Engine）的 MCP 服务器，它借助虚幻引擎的 Python 远程执行功能，为开发者提供便捷的操作体验。

hero

gif

Twitter · Discord

🚀 快速开始

unreal - mcp 服务器利用虚幻引擎内置的 Python 远程执行协议，无需安装新的 UE 插件。并且由于无需编写任何 C++ 代码，添加新工具或功能的开发速度更快。它还能支持完整的虚幻引擎 Python API。

✨ 主要特性

⚡ 与其他服务器的差异

此服务器使用内置的 Python 远程执行协议，无需安装新的 UE 插件。
由于无需任何 C++ 代码，添加新工具/功能的开发速度快得多。
可以支持完整的虚幻引擎 Python API

⚠️ 重要提示

这不是官方的虚幻引擎项目。
您的 AI 代理或工具将可以完全访问您的编辑器。
在批准客户端建议的任何更改之前，请先进行审核。

📦 安装指南

📋 安装要求

🔧 虚幻引擎 5.4+（已验证，早期版本可能也适用）
🟢 带有 npx 的 Node.js
🤖 MCP 客户端（Claude、Cursor 等）

安装步骤

编辑器设置：
- 打开您的虚幻引擎项目。
- 转到 编辑 -> 插件。
- 搜索“Python 编辑器脚本插件”并启用它。
- 如果提示，请重启编辑器。
- 转到 编辑 -> 项目设置。
- 搜索“Python”并启用“启用远程执行”选项。

enable plugin enable remote execution

客户端设置：
- 编辑您的 Claude（或 Cursor）配置。

{
  "mcpServers": {
    "unreal": {
      "command": "npx",
      "args": [
        "-y",
        "@runreal/unreal-mcp"
      ]
    }
  }
}

🔧 故障排除

如果您遇到类似于 MCP Unreal: Unexpected token 'C', Connection... 的错误，这意味着 mcp - 服务器无法连接到虚幻编辑器。

确保已启用 Python 编辑器脚本插件，并在项目设置中勾选了远程执行选项。
也可以尝试将绑定地址从 127.0.0.1 更改为 0.0.0.0，但请注意，这将允许来自本地网络的连接。
完全重启您的虚幻编辑器。
完全关闭/打开您的客户端（Claude、Cursor 等），以确保它重新连接到 MCP 服务器（在 Windows 上为 文件 -> 退出）。
检查正在运行的进程，并终止任何僵尸 unreal - mcp Node.js 进程。

🛠️ 可用工具

| 属性 | 详情 | |------|------| | set_unreal_engine_path | 设置虚幻引擎路径 | | set_unreal_project_path | 设置项目路径 | | get_unreal_engine_path | 获取当前虚幻引擎路径 | | get_unreal_project_path | 获取当前虚幻项目路径 | | editor_run_python | 在虚幻编辑器中执行任何 Python 代码 | | editor_list_assets | 列出所有虚幻资产 | | editor_export_asset | 将虚幻资产导出为文本 | | editor_get_asset_info | 获取资产信息，包括静态网格体和骨骼网格体资产的 LOD 级别 | | editor_get_asset_references | 获取资产的引用 | | editor_console_command | 在虚幻中运行控制台命令 | | editor_project_info | 获取当前项目的详细信息 | | editor_get_map_info | 获取当前地图/关卡的详细信息 | | editor_search_assets | 按名称或路径搜索资产，并可选择类过滤器 | | editor_get_world_outliner | 获取当前世界中所有具有属性的 actors | | editor_validate_assets | 验证项目中的资产以检查错误 | | editor_create_object | 在世界中创建新的对象/actor | | editor_update_object | 更新世界中现有的对象/actor | | editor_delete_object | 从世界中删除对象/actor | | editor_take_screenshot | 截取虚幻编辑器的屏幕截图 | | editor_move_camera | 将视口相机移动到特定位置和旋转以定位屏幕截图 |

🤝 贡献代码

欢迎您随时提出问题或提交拉取请求。我们尤其欢迎添加新工具/命令的贡献。

📄 许可证

本项目采用 MIT 许可证。

unreal-mcp