MCP Unreal Server

🚀 MCP Unreal Server 中文文檔

MCP Unreal Server 是一款強大的服務器實現，它能夠通過遠程 Python 執行與 Unreal Engine 實例進行交互，為開發者提供了便捷的操作方式，極大地提升了開發效率。

🚀 快速開始

MCP Unreal Server 可幫助開發者通過遠程 Python 執行與 Unreal Engine 實例交互。以下是啟動服務器的命令：

python -m src.mcp_server_unreal.server

✨ 主要特性

• 🚀 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)  # 控制檯日誌

支持工具

連接到 Unreal 實例

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

執行 Python 代碼

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

💻 使用示例

基礎用法

啟動服務器：

python -m src.mcp_server_unreal.server

高級用法

連接到 Unreal 實例並執行 Python 代碼：

{
  "host": "239.0.0.1",
  "port": 6766,
  "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 許可證。