Unity MCP Server 使用说明

项目简介

Unity MCP Server 是一个 Unity 编辑器扩展,它充当 Model Context Protocol (MCP) 服务器,允许 AI 驱动的 MCP 客户端(如 Claude Desktop 或 Cursor)与 Unity 编辑器进行通信和控制。通过提供标准化的接口,Unity MCP Server 使得 AI 客户端能够执行各种 Unity 编辑器操作,从而增强开发者的工作流程。

主要功能点

  • AI 集成: 允许 MCP 客户端利用 AI 功能与 Unity 编辑器进行交互。
  • MCP 通信: 建立 MCP 客户端与 Unity 编辑器之间的桥梁,实现无缝通信。
  • 丰富的编辑器操作: 支持广泛的 Unity 编辑器操作,包括场景管理、对象操作、资源管理、脚本编辑和编辑器控制等。

安装步骤

  1. 访问 GitHub 仓库的 Releases 页面 下载最新的 Unity Package ('.unitypackage' 文件)。
  2. 在 Unity 编辑器中,选择 "Assets" -> "Import Package" -> "Custom Package",然后导入下载的 '.unitypackage' 文件。
  3. 导入完成后,Unity MCP Server 组件将自动安装到您的 Unity 项目中。您可以通过 "Window" -> "Unity MCP" 菜单打开编辑器窗口,查看服务器状态和配置选项。

服务器配置

要使 MCP 客户端连接到 Unity MCP Server,您需要在 MCP 客户端中配置一个新的 MCP 服务器。以下是配置信息(JSON 格式),请根据您的 MCP 客户端进行配置:

{
  "serverName": "unityMCP",  // 服务器名称,可以自定义
  "command": "uv",           // 启动服务器的命令,这里使用 uv 包管理器
  "args": [                  // 命令参数列表
    "--directory",           // 指定 Python 服务器脚本所在的目录
    "<unity-project-path>/Assets/unity-mcp/Python", //  **请替换为您的 Unity 项目中 unity-mcp 包内 Python 目录的实际路径**,例如 "Assets/unity-mcp/Python" 或 "Packages/com.justinpbarnett.unity-mcp/Python"。路径取决于您的包安装位置。
    "run",                   //  uv 命令的动作,表示运行脚本
    "server.py"              //  服务器 Python 脚本的名称
  ]
}

注意: 请将 '<unity-project-path>/Assets/unity-mcp/Python' 替换为您 Unity 项目中 'unity-mcp' 包内 'Python' 目录的实际路径。此路径取决于您在 Unity 项目中安装 'unity-mcp' 包的方式(例如,通过 Package Manager 安装或直接导入到 Assets 文件夹)。

基本使用方法

  1. 在 Unity 编辑器中,打开 "Window" -> "Unity MCP" 窗口,确认 Unity MCP Bridge 正在运行。
  2. 在您的 MCP 客户端(如 Cursor 或 Claude Desktop)中,按照其配置说明添加新的 MCP 服务器,并将上述 JSON 配置信息填入。
  3. 启动您的 MCP 客户端。客户端应该能够自动连接到运行在 Unity 编辑器内的 Unity MCP Server。
  4. 通过 MCP 客户端,您可以使用自然语言指令或客户端提供的界面,向 Unity 编辑器发送指令,例如创建游戏对象、修改场景、编写脚本等。

信息

分类

开发者工具