Unitymcp

🚀 Unity MCP 入門指南

本指南將幫助你快速集成和使用 MCP 協議到你的 Unity 項目中，詳細介紹安裝配置、使用示例、通信協議等內容。

🚀 快速開始

按照以下步驟，你可以輕鬆地在 Unity 項目中集成和使用 MCP 協議。

📦 安裝指南

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 Server。
3. Unity 根據請求路徑找到對應的 Handler。
4. Handler 在 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 Server 監聽端口
  "workers": 4,        # 工作進程數
  "logging": {
    "level": "debug",   # 日誌級別：debug、info、warning、error
    "console": true      # 是否啟用控制檯日誌
  }
}

📚 詳細文檔

故障排除

更多資源

• 官方文檔
• 示例項目
• 開發者論壇