Unity MCP 包

一个 Unity 包，可以通过模型上下文协议 (MCP) 实现 Unity 和大型语言模型 (LLM)（如 Claude Desktop）之间的无缝通信。此服务器充当桥梁，允许 Unity 向符合 MCP 规范的工具发送命令并接收响应，从而使开发人员能够自动化工作流程、操作资源并以编程方式控制 Unity 编辑器。

欢迎使用此开源项目的初始版本！无论您是希望将 LLM 集成到您的 Unity 工作流程中，还是为令人兴奋的新工具做出贡献，我都感谢您抽出时间来查看它！

概述

Unity MCP 服务器在 Unity（通过 C#）和 Python 服务器之间提供双向通信通道，从而实现：

• 资源管理：以编程方式创建、导入和操作 Unity 资源。
• 场景控制：管理场景、对象及其属性。
• 材质编辑：修改材质及其属性。
• 脚本集成：查看、创建和更新 Unity 脚本。
• 编辑器自动化：控制 Unity 编辑器功能，如撤消、重做、播放和构建。

此项目非常适合希望利用 LLM 来增强其 Unity 项目或自动化重复性任务的开发人员。

安装

要使用 Unity MCP 包，请确保已安装以下内容：

• Unity 2020.3 LTS 或更高版本（⚠️ 目前仅适用于 URP 项目）
• Python 3.12 或更高版本
• uv 包管理器

步骤 1：安装 Python

从 python.org 下载并安装 Python 3.12 或更高版本。 确保在安装过程中将 Python 添加到系统的 PATH 中。

步骤 2：安装 uv

uv 是一个 Python 包管理器，可简化依赖项管理。 使用以下命令根据您的操作系统安装它：

• Mac:

  brew install uv
  

• Windows:

  powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
  

  然后，将 uv 添加到您的 PATH：

  set Path=%USERPROFILE%\.local\bin;%Path%
  

• Linux:

  curl -LsSf https://astral.sh/uv/install.sh | sh
  

有关其他安装方法，请参阅 uv 安装指南。

重要提示：请勿在未安装 uv 的情况下继续。

步骤 3：安装 Unity 包

1. 打开 Unity 并转到 Window > Package Manager。
2. 单击 + 按钮并选择 Add package from git URL。
3. 输入：https://github.com/justinpbarnett/unity-mcp.git

安装完成后，Unity MCP 包将在您的 Unity 项目中可用。 当与 MCP 客户端（如 Claude Desktop 或 Cursor）一起使用时，服务器将自动启动。

特性

• 双向通信：在 Unity 和 LLM 之间无缝发送和接收数据。
• 资源管理：导入资源、实例化预制件以及以编程方式创建新的预制件。
• 场景控制：打开、保存和修改场景，以及创建和操作游戏对象。
• 材质编辑：轻松应用和修改材质。
• 脚本集成：在 Unity 中创建、查看和更新 C# 脚本。
• 编辑器自动化：自动化 Unity 编辑器任务，如构建项目或进入播放模式。

贡献

我非常希望您能帮助使 Unity MCP 服务器变得更好！ 以下是如何贡献：

1. Fork 存储库 Fork github.com/justinpbarnett/unity-mcp 到您的 GitHub 帐户。

2. 创建分支

   git checkout -b feature/your-feature-name
   

   或

   git checkout -b bugfix/your-bugfix-name
   

3. 进行更改 实现您的功能或修复。

4. 提交和推送 使用清晰、描述性的提交消息：

   git commit -m "Add feature: your feature description"
   git push origin feature/your-feature-name
   

5. 提交 Pull Request 打开一个到 master 分支的 pull request，其中包含对您所做更改的描述。

许可证

本项目根据 MIT 许可证 获得许可。 随意使用、修改和分发它，只要您认为合适。 请在此处查看完整许可证 here。

故障排除

遇到问题？ 尝试以下修复方法：

• Unity Bridge 未运行 确保 Unity 编辑器已打开并且 MCP 窗口处于活动状态。 如果需要，重新启动 Unity。

• Python 服务器未连接 验证 Python 和 uv 是否已正确安装，以及 Unity MCP 包是否已正确设置。

• Claude Desktop 或 Cursor 的配置问题 确保您的 MCP 客户端配置为与 Unity MCP 服务器通信。

如需更多帮助，请访问 issue tracker 或提交新 issue。

联系方式

有疑问或想聊聊项目？ 联系我们！

• X: @justinpbarnett

致谢

非常感谢所有支持此项目初始版本的人。 特别感谢 Unity Technologies 提供的出色编辑器 API。

祝您编码愉快，并享受将 LLM 与 Unity 集成！