MCP Unreal Server

🚀 MCP Unreal Server 日本語ドキュメント

MCP Unreal Serverは、リモートPython実行を通じてUnreal Engineインスタンスとやり取りするためのサーバー実装です。このサーバーにより、Unreal Engine環境でのPythonコードの実行や、Unrealインスタンスの管理が可能になります。

✨ 主な機能

• 🚀 Unrealインスタンス管理

  • マルチキャストを通じてUnrealノードを自動検出します。
  • ノードの状態をリアルタイムで監視します。
  • LSP互換のクライアントを通じてリソースを一覧表示できます。

• 💻 リモート実行

  • Unreal Engine環境でPythonコードを実行できます。
  • attendedとunattendedの実行モードをサポートしています。
  • ファイル実行と文評価モードがあります。

• 📊 ログ記録と監視

  • 詳細なログをファイル (mcp_unreal.log) に出力します。
  • コンソールログには異なる詳細度のレベルがあります。
  • ノードの接続状態をヘルスチェックします。

📦 インストール

# リポジトリをクローンする
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ライセンス