使用说明

项目简介

Unity MCP Integration 是一个为 Unity 编辑器设计的 Model Context Protocol (MCP) 服务器实现。它允许 AI 助手通过 MCP 协议无缝集成到 Unity 编辑器中，从而实现对 Unity 项目的实时理解和交互。通过此集成，AI 助手可以获取场景层级结构、项目设置等信息，并执行 C# 代码，极大地扩展了 AI 在 Unity 开发中的应用场景。

主要功能点

实时 Unity 编辑器状态访问: 提供当前 Unity 编辑器的详细状态信息，包括活跃的游戏对象、选择对象、播放模式状态、场景层级结构等。
场景信息获取: 允许 AI 助手获取当前场景的详细信息，包括场景名称、路径、是否已修改以及根对象列表，并支持不同层级的详细程度（仅根对象或完整层级）。
游戏对象信息查询: 支持根据实例 ID 查询特定游戏对象的详细信息，包括其属性、组件、子对象等，并可配置信息的详细程度。
C# 代码执行: 允许 AI 助手在 Unity 编辑器环境中直接执行 C# 代码，实现动态修改场景、调用编辑器功能等高级操作。
Unity 编辑器日志检索: 提供检索 Unity 编辑器控制台日志的功能，支持按日志类型、数量、内容、时间范围等进行过滤。
连接状态验证: 提供工具验证 MCP 服务器与 Unity 编辑器的连接状态。

安装步骤

安装 Unity Package:

方法 A: Package Manager (Git URL)
- 打开 Unity Package Manager ('Window > Package Manager')
- 点击 '+' 按钮，选择 'Add package from git URL...'
- 输入仓库 URL: 'https://github.com/quazaai/UnityMCPIntegration.git'
- 点击 'Add'
方法 B: Import Custom Package
- 克隆此仓库或下载 ZIP 文件
- 在 Unity 中，选择 'Assets > Import Package > Custom Package'
- 选择 'UnityMCPIntegration.unitypackage' 文件

设置 MCP 服务器:

进入 'mcpServer' 目录
安装依赖:
```
npm install
```
运行服务器:
```
node build/index.js
```

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数，以便连接到 Unity MCP 服务器。以下是配置示例，请根据实际项目路径进行调整：

{
  "mcpServers": {
    "unity-mcp-server": {
      "command": "node",
      "args": [
        "<path-to-project>/mcpServer/build/index.js"  // 将 <path-to-project> 替换为您的项目路径
      ]
    }
  }
}

参数说明:

'"unity-mcp-server"': 服务器名称，可以自定义。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行环境。
'"args"': 命令参数数组。
- '"<path-to-project>/mcpServer/build/index.js"': MCP 服务器入口文件 'index.js' 的完整路径。请务必将 '<path-to-project>' 替换为您的 UnityMCPIntegration 项目在您电脑上的实际路径。

基本使用方法

启动 MCP 服务器: 按照 "设置 MCP 服务器" 步骤启动 Node.js 服务器。
打开 Unity 编辑器: 确保已安装 UnityMCPIntegration Unity Package 的 Unity 编辑器处于运行状态。
连接服务器: 在 Unity 编辑器中，打开 'Window > MCP Debug' 窗口。在窗口中，可以查看连接状态，并点击 "Connect" 按钮手动连接服务器。默认端口为 '8080'，如有需要可以在端口字段中修改。
监控和调试: 在 MCP Debug 窗口中，可以监控连接状态、查看日志信息、测试代码执行等功能，以验证和调试 MCP 服务器的运行情况。

关键词