MCP 服务器

Unity MCP Integration

一个服务器，使人工智能助手能够实时理解并与 Unity 项目交互，提供对场景层级结构、项目设置的访问，并能够直接在 Unity 编辑器中执行代码。

README

🚀 高级 Unity MCP 集成

此包提供了模型上下文协议 (MCP) 和 Unity 编辑器之间的无缝集成，允许 AI 助手实时理解并与您的 Unity 项目交互。通过此集成，AI 助手可以访问有关您的场景层级结构、项目设置的信息，并直接在 Unity 编辑器上下文中执行代码。

📚 功能

直接浏览和操作项目文件
访问有关您的 Unity 项目的实时信息
了解您的场景层级结构和游戏对象
直接在 Unity 编辑器中执行 C# 代码
监控日志和错误
控制编辑器的播放模式
等待代码执行

🚀 开始使用

前提条件

Unity 2021.3 或更高版本
Node.js 18+（用于运行 MCP 服务器）

安装

1. 安装 Unity 包

您有几个选项来安装 Unity 包：

选项 A：包管理器（Git URL）

打开 Unity 包管理器 (Window > Package Manager)
单击 + 按钮并选择 Add package from git URL...
输入存储库 URL：https://github.com/quazaai/UnityMCPIntegration.git
单击 Add

选项 B：导入自定义包

克隆此存储库或将其下载为 unityPackage
在 Unity 中，转到 Assets > Import Package > Custom Package
选择 UnityMCPIntegration.unitypackage 文件

2. 设置 MCP 服务器

您有两个选项来运行 MCP 服务器：

选项 A：直接运行服务器

导航到 mcpServer (可能 <path-to-project>\Library\PackageCache\com.quaza.unitymcp@d2b8f1260bca\mcpServer\) 目录
安装依赖项：
```
npm install
```
运行服务器：
```
node build/index.js
```

选项 B：添加到 MCP Host 配置

将服务器添加到您的 MCP Host 配置，用于 Claude Desktop、自定义实现等

{
  "mcpServers": {
    "unity-mcp-server": {
      "command": "node",
      "args": [
        "path-to-project>\\Library\\PackageCache\\com.quaza.unitymcp@d2b8f1260bca\\mcpServer\\mcpServer\\build\\index.js"
      ],
      "env": {
        "MCP_WEBSOCKET_PORT": "5010"
      }
    }
  }
}

演示视频

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 Unity MCP Integration：

npx -y @smithery/cli install @quazaai/unitymcpintegration --client claude

🔧 用法

调试和监控

您可以在 Unity 中打开 MCP 调试窗口来监控连接并测试功能：

转到 Window > MCP Debug
使用调试窗口来：
- 检查连接状态
- 测试代码执行
- 查看日志
- 监控事件

可用工具

Unity MCP 集成为 AI 助手提供了几个工具：

Unity 编辑器工具

get_editor_state: 获取有关 Unity 项目和编辑器状态的全面信息
get_current_scene_info: 获取有关当前场景的详细信息
get_game_objects_info: 获取有关场景中特定游戏对象的信息
execute_editor_command: 直接在 Unity 编辑器中执行 C# 代码
get_logs: 检索和过滤 Unity 控制台日志
verify_connection: 检查是否与 Unity 编辑器建立了活动连接

文件系统工具

read_file: 读取 Unity 项目中文件的内容
read_multiple_files: 一次读取多个文件
write_file: 创建或覆盖具有新内容的文件
edit_file: 使用差异预览对现有文件进行有针对性的编辑
list_directory: 获取目录中文件和文件夹的列表
directory_tree: 获取目录和文件的分层视图
search_files: 查找与搜索模式匹配的文件
get_file_info: 获取有关特定文件或目录的元数据
find_assets_by_type: 查找特定类型的所有资源（例如，材质、预制件）
list_scripts: 获取项目中所有 C# 脚本的列表

文件路径可以是绝对路径，也可以是相对于 Unity 项目的 Assets 文件夹的相对路径。例如，"Scenes/MyScene.unity" 指的是 <project>/Assets/Scenes/MyScene.unity。

🛠️ 架构

该集成由两个主要组件组成：

Unity 插件 (C#)：驻留在 Unity 编辑器中，并提供对编辑器 API 的访问
MCP 服务器 (TypeScript/Node.js)：实现 MCP 协议并与 Unity 插件通信

它们之间的通信通过 WebSocket 进行，传输用于命令和数据的 JSON 消息。

文件系统访问

Unity MCP 集成现在包含强大的文件系统工具，允许 AI 助手：

浏览、读取和编辑 Unity 项目中的文件
创建新文件和目录
搜索特定文件或资源类型
分析您的项目结构
使用差异预览进行有针对性的代码更改

所有文件操作都限制在 Unity 项目目录中以确保安全。该系统智能地处理绝对路径和相对路径，始终将它们解析为相对于项目 Assets 文件夹的路径，以方便使用。

用法示例：

获取目录列表：list_directory(path: "Scenes")
读取脚本文件：read_file(path: "Scripts/Player.cs")
编辑配置文件：edit_file(path: "Resources/config.json", edits: [{oldText: "value: 10", newText: "value: 20"}], dryRun: true)
查找所有材质：find_assets_by_type(assetType: "Material")