Unitymcp

🚀 Unity MCP 入門ガイド

Unity MCPを使用することで、UnityプロジェクトとTypeScriptサーバー間の通信を容易に行うことができます。このガイドでは、MCPのインストール、設定、基本的な使用方法、通信プロトコル、およびトラブルシューティングについて説明します。

🚀 クイックスタート

MCPをUnityプロジェクトに統合するには、以下の手順に従ってください。

✨ 主な機能

• UnityプロジェクトとTypeScriptサーバー間の通信を容易にする。
• 基本的なコマンドハンドラーとリソースハンドラーを提供する。
• JSON形式の通信プロトコルをサポートする。

📦 インストール

Unity 端インストール手順

1. 最新バージョンのMCPモジュールをダウンロードします。
2. モジュールファイル（.unitypackage）をUnityプロジェクトにインポートします。
3. Assets/Editor フォルダーの下に新しい空のファイルを作成し、McpServerSettings.cs と名付けます。
4. 以下の内容をこのファイルに追加します。

using UnityEngine;
using ModelContextProtocol;

public static class McpServerSettings {
    public const bool StartOnLaunch = true; // Unity起動時にサーバーを自動起動するかどうか
    public const bool RestartOnPlayModeChange = true; // Playモード切り替え時にサーバーを再起動するかどうか
}

5. Edit > Preferences > Projects > External Tools を開き、Enable MCP Server Support をチェックします。

TypeScript 端インストール手順

1. MCPサンプルプロジェクトのリポジトリをクローンします。
2. 依存関係をインストールします。

   npm install @model-context-protocol/mcp-typings @model-context-protocol/mcp-server
   

3. TypeScriptサーバーを起動します。

   npm run start
   

💻 使用例

基本的な使用法

基本Command Handlerの作成（C#）

Assets/Editor フォルダーの下に新しいC#スクリプトを作成し、HelloWorldCommandHandler.cs と名付けます。

using UnityEngine;
using ModelContextProtocol;

public class HelloWorldCommandHandler : CommandHandler {
    protected override void Handle(string[] args) {
        // ここにビジネスロジックを実装します
        Debug.Log("Hello, World!");
    }
}

基本Resource Handlerの作成（C#）

Assets/Editor フォルダーの下に新しいC#スクリプトを作成し、MyResourceHandler.cs と名付けます。

using UnityEngine;
using ModelContextProtocol;

public class MyResourceHandler : ResourceHandler {
    protected override async Task<HttpResponse> Handle(Request request) {
        // ここにビジネスロジックを実装します
        return await Response.Ok("Hello, World!");
    }
}

基本Command Handlerの作成（TypeScript）

handlers/commands フォルダーの下に新しいTypeScriptファイルを作成し、hello-world.ts と名付けます。

import { CommandHandler } from "@model-context-protocol/mcp-server";

export class HelloWorldCommand extends CommandHandler {
    async execute(args: string[]): Promise<string> {
        // ここにビジネスロジックを実装します
        return "Hello, World!";
    }
}

📚 ドキュメント

通信プロトコル

基本リクエストレスポンス構造（JSON）

{
    "id": "123",         // リクエストの一意の識別子
    "type": "command",   // リクエストのタイプ。command、resource、またはpromptになります。
    "method": "GET",     // HTTPメソッド。GET、POSTなどです。
    "path": "/hello",    // リクエストのパス
    "body": {           // リクエストの本文
        "message": "Hello"
    }
}

レスポンス構造（JSON）

{
    "id": "123",
    "success": true,     // 成功したかどうか
    "result": {         // レスポンスの結果
        "greeting": "World"
    }
}

リクエストフロー

1. クライアントがTypeScriptサーバーにリクエストを送信します。
2. サーバーがリクエストをUnity MCPサーバーに転送します。
3. Unityがリクエストパスに基づいて対応するハンドラーを見つけます。
4. ハンドラーがUnityのメインスレッドでリクエストを処理します。
5. レスポンス結果がTypeScriptサーバーに返されます。
6. サーバーが結果をJSON形式にフォーマットしてクライアントに返します。

設定参考

サンプル McpServerSettings.cs

using UnityEngine;
using ModelContextProtocol;

public static class McpServerSettings {
    public const bool StartOnLaunch = true; // Unity起動時にサーバーを自動起動するかどうか
    public const bool RestartOnPlayModeChange = true; // Playモード切り替え時にサーバーを再起動するかどうか
}

サンプル mcp-config.json

{
  "port": 5005,         // MCPサーバーがリッスンするポート
  "workers": 4,        // ワーカープロセスの数
  "logging": {
    "level": "debug",   // ログレベル：debug、info、warning、error
    "console": true      // コンソールログを有効にするかどうか
  }
}

トラブルシューティング

一般的な問題と解決策

その他のリソース

• 公式ドキュメント
• サンプルプロジェクト
• 開発者フォーラム

以上の手順に従うことで、MCPプロトコルをUnityプロジェクトに簡単に統合して使用することができます。