使用说明

项目简介

MCP Unreal Server 是一个基于 Model Context Protocol (MCP) 构建的服务器实现，旨在为 LLM 客户端提供与 Unreal Engine 实例交互的桥梁。通过此服务器，您可以远程管理 Unreal Engine 资源，并在 Unreal Engine 环境中执行 Python 代码，从而实现更强大的自动化和扩展功能。

主要功能点

Unreal Engine 实例管理：自动发现和监控局域网内的 Unreal Engine 实例，实时掌握节点状态，并列出可用资源。
远程 Python 代码执行：在 Unreal Engine 环境中执行 Python 代码，支持多种执行模式（文件执行、语句执行、表达式求值），满足不同的自动化需求。
日志与监控：提供详细的日志记录和控制台输出，方便问题排查和状态监控。

安装步骤

克隆仓库

git clone https://github.com/radial-hks/MCP-Unreal-Server.git
cd MCP-Unreal-Server

安装依赖

pip install -r requirements.txt

服务器配置

MCP 客户端需要配置以下信息以连接到 MCP Unreal Server：

{
  "serverName": "mcp-server-unreal",
  "command": "python",
  "args": ["-m", "src.mcp_server_unreal.server"]
}

配置参数说明:

'serverName': 服务器名称，设置为 "mcp-server-unreal"。
'command': 启动服务器的命令，这里使用 'python'。
'args': 启动服务器命令的参数，使用 '-m src.mcp_server_unreal.server' 来运行服务器模块。

基本使用方法

启动服务器：在终端中，导航到仓库根目录，并执行以下命令启动 MCP Unreal Server：
```
python -m src.mcp_server_unreal.server
```
服务器成功启动后，将开始监听 MCP 客户端的请求。
使用 MCP 客户端连接：配置您的 MCP 客户端，使其连接到正在运行的 MCP Unreal Server。客户端应能自动发现并列出 Unreal Engine 实例资源和可用的工具。

调用工具：

连接 Unreal 实例 (connect-unreal)：

工具名称: 'connect-unreal'

参数 (可选):

{
  "host": "239.0.0.1",  // Multicast组地址，默认为 239.0.0.1
  "port": 6766         // Multicast端口，默认为 6766
}

此工具用于手动触发连接 Unreal Engine 实例的发现过程。通常服务器启动时会自动尝试连接。

执行 Python 代码 (execute-python)：

工具名称: 'execute-python'

参数:

{
  "code": "print('Hello Unreal')",  // 要执行的 Python 代码
  "unattended": true              // 是否以无人值守模式执行，默认为 true
}

此工具用于在已连接的 Unreal Engine 实例中执行指定的 Python 代码。

请参考仓库中的 'README.md' 和代码注释获取更详细的信息。

关键词