使用说明

项目简介

Unity MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端应用,旨在连接大型语言模型 (LLM) 与 Unity 游戏引擎。它允许 LLM 理解和操控 Unity 项目,通过提供对 Unity 编辑器和已构建播放器中资源和工具的访问能力,实现更智能化的游戏开发流程。

主要功能点

  • 资源管理: 将 Unity 场景层级结构、资源和组件作为 LLM 可访问的资源暴露出来。
  • 工具执行: 提供一系列预置工具,用于执行常见的 Unity 操作,例如创建/销毁游戏对象、添加/移除组件、实例化预制体以及搜索资源等。
  • 自定义工具支持: 设计为可扩展的架构,允许开发者为他们的 Unity 项目添加自定义工具(尽管由于 SDK 待解决问题,目前尚未完全支持)。
  • MCP 客户端集成: 通过 SignalR 使用 JSON-RPC 协议与 MCP 客户端(如 Claude desktop)通信,为 LLM 交互提供标准化的接口。
  • 跨 Unity 版本兼容性: 支持多个 Unity 版本 (2022.3, 2023.2, 6000.0) 以及多种环境(编辑器模式、播放模式、独立构建)。

安装步骤

  1. 安装 .NET 9.0: 从 Microsoft 官方网站下载并安装 .NET 9.0 SDK。
  2. 安装 OpenUPM-CLI: 如果尚未安装,请安装 OpenUPM-CLI。
  3. 添加到 Unity 项目: 打开您的 Unity 项目,并在命令行中使用 OpenUPM-CLI 添加 Unity-MCP 包:在您的 Unity 项目文件夹中运行命令 'openupm add com.ivanmurzak.unity.mcp'。

服务器配置

要将 MCP 客户端(例如 Claude desktop)连接到 Unity-MCP Server,您需要使用服务器的连接详细信息配置客户端。Unity-MCP Server 会将 JSON 配置打印到 Unity 控制台。

  1. 在 Unity 编辑器中,转到 'Tools/Unity-MCP/Server/Print Config'。
  2. 复制在控制台窗口中打印的 JSON 字符串。
  3. 将此 JSON 字符串粘贴到您的 MCP 客户端配置文件中。对于 Claude desktop:
    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

示例配置 (这是一个模板,实际配置会打印在 Unity 控制台中):

{
  "mcpServers": {
    "Unity-MCP": {
      "command": "[Unity 编辑器可执行文件的路径/Unity.exe 或类似的,取决于平台和构建类型]", // 指向运行 MCP 服务器的 Unity 编辑器或构建播放器可执行文件的路径。
      "args": [] // Unity 可执行文件的可选参数,通常不需要。
    }
  }
}

基本使用方法

  1. 启动 Unity-MCP Server: 确保 Unity 编辑器(或带有服务器的构建播放器)正在运行并已安装 Unity-MCP 包。服务器会自动启动。
  2. 连接 MCP 客户端: 使用从 Unity 控制台获取的 JSON 配置来配置您的 MCP 客户端(如 Claude desktop)。
  3. 通过 LLM 与 Unity 交互: 使用您的 MCP 客户端向 Unity-MCP 服务器发送请求。然后,您可以使用自然语言命令在 LLM 客户端中控制 Unity 编辑器、操作场景对象、资源等,从而利用暴露的工具和资源。

信息

分类

开发者工具