使用说明

项目简介

Unity MCP Server 是一个 Unity Package，它实现了 Model Context Protocol (MCP) 服务器，旨在将 Unity 编辑器的上下文信息安全且可扩展地提供给各种 AI 助手，如 Claude, Cursor AI 和 Windsurf。通过这个服务器，AI 助手可以访问 Unity 项目的控制台日志、项目资源、场景层级和检视面板属性，从而实现更智能的辅助开发功能。

主要功能点

上下文数据采集: 自动收集 Unity 编辑器的实时上下文数据，包括：
- Unity 控制台: 错误、警告和日志信息。
- 项目浏览器: 项目中的资源列表。
- 场景层级: 场景中的游戏对象结构。
- 检视面板: 当前选中游戏对象的属性信息。
多AI助手支持: 预置了对 Claude AI, Cursor AI 和 Windsurf 等 AI 服务的连接支持，方便快速集成。
可配置的服务器: 允许用户自定义服务器端口、数据更新频率和日志级别，以适应不同的使用场景和性能需求。
灵活的连接方式: 通过标准的 HTTP 协议提供服务，易于集成到各种 MCP 客户端。
易于安装和使用: 提供 Git URL 和手动安装两种方式，并提供友好的编辑器窗口界面进行配置和管理。

安装步骤

通过 Git URL 安装 (推荐):

打开 Unity 编辑器，进入 Window (窗口) -> Package Manager (包管理器)。
点击包管理器窗口左上角的 "+" 按钮。
选择 "Add package from git URL..." (从 Git URL 添加包...)。

在弹出的输入框中粘贴以下 Git URL：

https://github.com/folkward99/unity-mcp-server.git

点击 "Add" (添加) 按钮，等待 Unity 完成包的安装。

手动安装:

克隆 (Clone) 或下载本仓库到本地。
将仓库内容复制到你的 Unity 项目的 'Packages' 文件夹中。

服务器配置

MCP 服务器通过 HTTP 协议提供服务，默认监听 'http://localhost:8080'。以下是 MCP 客户端连接 Unity MCP Server 的一个配置示例 (JSON 格式):

{
  "serverName": "UnityMCP",          // MCP 服务器名称，自定义
  "command": "null",                 // 启动命令，由于 Unity MCP Server 作为 Unity 编辑器的一部分运行，无需外部启动命令，设为 null 即可
  "args": [                          // 启动参数，同样由于集成在 Unity 编辑器中，无需额外参数，留空数组即可
  ],
  "protocol": "json-rpc",            // 通信协议，固定为 json-rpc
  "transport": "http",               // 传输协议，固定为 http
  "handshake": {                     // 握手信息，可选
    "name": "Unity Editor",          // 客户端名称，可选
    "version": "2023.3.0f1"         // 客户端版本，可选，Unity 版本号
  },
  "endpoint": "http://localhost:8080" // MCP 服务器端点，默认为 http://localhost:8080，可根据实际情况修改
}

Unity MCP Server 自身配置:

Unity MCP Server 的配置界面位于 Unity 编辑器的 Window (窗口) -> MCP -> Server 菜单。你可以在该窗口中进行以下配置：

Port (端口): 设置 MCP 服务器监听的端口号，默认为 '8080'。
Update Frequency (更新频率): 设置服务器向 AI 服务发送上下文数据更新的频率，单位为秒，默认为 '1.0' 秒。
Log Level (日志级别): 设置服务器日志输出的详细程度，可以选择 Debug, Info, Warning, Error 等级别。
API Keys (API 密钥): 用于配置 Claude AI, Cursor AI 和 Windsurf 等 AI 服务的 API 密钥。

基本使用方法

打开 MCP Server 窗口: 在 Unity 编辑器中，点击 Window (窗口) -> MCP -> Server 打开 MCP Server 配置窗口。
配置 API 密钥 (可选): 如果你需要连接 Claude AI, Cursor AI 或 Windsurf 等 AI 服务，请在配置窗口中填写相应的 API 密钥。
配置服务器设置 (可选): 根据需要修改端口号、更新频率和日志级别等服务器设置。
启动 MCP Server: 在 MCP Server 窗口中，点击 "Start Server" (启动服务器) 按钮。
连接 AI 助手: 在你的 AI 助手 (如 Claude, Cursor AI, Windsurf) 中，配置连接到 Unity MCP Server 的端点 'http://localhost:8080' (或你自定义的端口)。
测试连接: 可以使用示例场景或脚本进行连接测试，例如运行 'Runtime/Scripts/Examples' 文件夹中的示例脚本。

启动服务器后，Unity 编辑器的上下文数据将定期发送到已连接的 AI 助手，从而在 AI 助手中使用 Unity 编辑器的上下文信息。

关键词