MCP Unreal Server 中文文档

项目简介

MCP Unreal Server 是一款用于通过远程 Python 执行与 Unreal Engine 实例交互的服务器实现。

功能

• 🚀 Unreal 实例管理

  • 通过多播自动发现 Unreal 节点
  • 实时节点状态监控
  • 通过兼容 LSP 的客户端列出资源

• 💻 远程执行

  • 在 Unreal Engine 环境中执行 Python 代码
  • 支持attended 和 unattended 执行模式
  • 文件执行和语句评估模式

• 📊 日志记录与监控

  • 详细日志输出到文件 (mcp_unreal.log)
  • 控制台日志带有不同级别的 verbosity
  • 节点连接状态健康监控

安装

# 克隆仓库
git clone https://github.com/your-org/mcp-unreal-server.git
cd mcp-unreal-server

# 安装依赖
pip install -r requirements.txt

配置

网络设置

在 RemoteExecutionConfig 中配置多播参数：

# 默认多播设置（修改在 server.py 中）
config.multicast_group_endpoint = ("239.0.0.1", 6766)

日志记录

在 server.py 中调整日志级别：

# 调整日志级别
file_handler.setLevel(logging.DEBUG)  # 文件日志
console_handler.setLevel(logging.INFO)  # 控制台日志

使用方法

启动服务器

python -m src.mcp_server_unreal.server

支持工具

1. 连接到 Unreal 实例

{
  "host": "239.0.0.1",
  "port": 6766
}

2. 执行 Python 代码

{
  "node_id": "<unreal-node-id>",
  "code": "print('Hello Unreal')",
  "unattended": true
}

API 文档

资源格式

types.Resource(
    uri="unreal://<node_id>",
    name=f"Unreal 实例: {node_id}",
    description="Unreal Engine 实例",
    mimeType="application/x-unreal"
)

执行模式

故障排除

常见问题：

• 没有节点被发现：确认 Unreal 实例正在运行且启用了 MCP 插件
• 执行超时：检查防火墙设置是否允许多播流量
• 连接中断：监控 mcp_unreal.log 中的节点状态变化

许可证

Apache-2.0 许可证