通过Git URL安装-备份版本
- 打开你的Unity项目。
- 首选
Window > Package Manager. - 点击
+->Add package from git URL.... - 输入:
https://github.com/mechatronod/Unity-MCP-bckup.git?path=/MCPForUnity- 点击
Add.
自豪地赞助和维护 科普利 --Unity的最佳AI助手。
    

使用LLM创建Unity应用程序!
MCP for Unity充当桥梁,允许AI助手(如Claude、Cursor)通过本地编辑器直接与Unity编辑器交互 MCP(模型上下文协议)客户端给你的LLM工具来管理Unity中的资产、控制场景、编辑脚本和自动化任务。
主要特点🚀
- 🗣️ 自然语言控制: 指导你的法学硕士执行Unity任务。
- 🛠️ 强大的工具: 管理资源、场景、材质、脚本和编辑器功能。
- 🤖 自动化: 自动化重复的Unity工作流程。
- 🧩 可扩展: 设计用于与各种MCP客户端配合使用。
Tools
您的LLM可以使用以下函数:
execute_menu_item:执行Unity编辑器菜单项(例如“文件/保存项目”)。manage_asset:执行资产操作(导入、创建、修改、删除等)。manage_editor:控制和查询编辑器的状态和设置。manage_gameobject:管理游戏对象:创建、修改、删除、查找和组件操作。manage_prefabs:执行预制操作(创建、修改、删除等)。manage_scene:管理场景(加载、保存、创建、获取层次结构等)。manage_script:用于旧脚本操作(创建、读取、删除)的兼容性路由器。更喜欢apply_text_edits或script_apply_edits用于编辑。manage_shader:执行着色器CRUD操作(创建、读取、修改、删除)。read_console:从控制台获取消息或清除控制台。run_tests:在Unity编辑器中运行测试。set_active_instance:将后续工具调用路由到特定的Unity实例(当多个正在运行时)。apply_text_edits:使用前置条件哈希和原子多编辑批次进行精确的文本编辑。script_apply_edits:具有更安全边界的结构化C#方法/类编辑(插入/替换/删除)。validate_script:快速验证(基本/标准),以捕捉写入前后的语法/结构问题。create_script:在给定的项目路径上创建一个新的C#脚本。delete_script:按URI或资产相对路径删除C#脚本。get_sha:获取Unity C#脚本的SHA256和基本元数据,而不返回文件内容。
Resources
您的法学硕士可以检索以下资源:
unity_instances:列出所有正在运行的Unity Editor实例及其详细信息(名称、路径、端口、状态)。menu_items:检索Unity编辑器中的所有可用菜单项。tests:检索Unity编辑器中的所有可用测试。可以选择特定类型的测试(例如,“编辑模式”、“播放模式”)。editor_active_tool:当前活动的编辑器工具(移动、旋转、缩放等)和变换控制柄设置。editor_prefab_stage:如果预制件以隔离模式打开,则显示当前预制件编辑上下文。editor_selection:编辑器中当前选定对象的详细信息。editor_state:当前编辑器运行时状态,包括播放模式、编译状态、活动场景和选择摘要。editor_windows:当前打开的所有编辑器窗口及其标题、类型、位置和焦点状态。project_info:静态项目信息,包括根路径、Unity版本和平台。project_layers:项目的TagManager中定义的所有图层及其索引(0-31)。project_tags:项目的TagManager中定义的所有标记。
运作原理
MCP for Unity使用两个组件连接您的工具:
- Unity Bridge的MCP: 编辑器内运行的Unity包。(通过软件包管理器安装)。
- Unity服务器的MCP: 本地运行的Python服务器,在Unity Bridge和MCP客户端之间进行通信。(首次运行时由软件包自动安装或通过自动设置安装;手动设置可作为回退)。
______________________________________________________________________
安装⚙️
先决条件
- python 版本3.10或更高版本。 下载Python
- Unity中心和编辑器: 版本2021.3 LTS或更新版本。 下载Unity
- uv(Python工具链管理器):
# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows (PowerShell)
winget install --id=astral-sh.uv -e
# Docs: https://docs.astral.sh/uv/getting-started/installation/- [Optional] Roslyn for Advanced Script Validation
For **Strict** validation level that catches undefined namespaces, types, and methods:
**Method 1: NuGet for Unity (Recommended)**
1. Install [NuGetForUnity](https://github.com/GlitchEnzo/NuGetForUnity)
2. Go to `Window > NuGet Package Manager`
3. Search for `Microsoft.CodeAnalysis`, select version 4.14.0, and install the package
4. Also install package `SQLitePCLRaw.core` and `SQLitePCLRaw.bundle_e_sqlite3`.
5. Go to `Player Settings > Scripting Define Symbols`
6. Add `USE_ROSLYN`
7. Restart Unity
**Method 2: Manual DLL Installation**
1. Download Microsoft.CodeAnalysis.CSharp.dll and dependencies from [NuGet](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp/)
2. Place DLLs in `Assets/Plugins/` folder
3. Ensure .NET compatibility settings are correct
4. Add `USE_ROSLYN` to Scripting Define Symbols
5. Restart Unity
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.______________________________________________________________________
🌟 步骤1:安装Unity软件包
通过Git URL安装
- 打开你的Unity项目。
- 首选
Window > Package Manager. - 点击
+->Add package from git URL.... - 输入:
https://github.com/mechatronod/Unity-MCP-bckup.git?path=/MCPForUnity- 点击
Add.
通过OpenUPM安装
- 安装 OpenUPM命令行界面
- 打开终端(PowerShell、终端等)并导航到Unity项目目录
- 跑
openupm add com.coplaydev.unity-mcp
注: 如果您在Coplay维护之前安装了MCP服务器,则需要在重新安装新软件包之前卸载旧软件包。
🛠️ 步骤2:配置MCP客户端
将您的MCP客户端(Claude、Cursor等)连接到步骤1中设置的Python服务器(自动)或通过手动配置(如下)。
选项A:自动设置(建议用于Claude/Cursor/VSC副驾驶)
- 在Unity中,转到
Window > MCP for Unity. - 点击
Auto-Setup. - 寻找绿色状态指示器🟢 以及“已连接”✓". *(这会尝试自动修改MCP客户端的配置文件)。*
Client-specific troubleshooting
- VSCode:使用
Code/User/mcp.json与顶级servers.unityMCP和"type": "stdio"在Windows上,MCP for Unity编写了一个绝对uv.exe(更喜欢WinGet链接垫片)以避免PATH问题。 - 光标/风帆 (帮助链接):如果
uv缺少,Unity的MCP窗口显示“未找到uv”,并带有快速\[HELP\]链接和“选择”uv安装位置”按钮。 - 克劳德代码 (帮助链接):如果
claude如果未找到,窗口将显示“未找到克劳德”,并显示\[HELP\]和“选择克劳德位置”按钮。注销立即更新UI。
选项B:手动配置
如果自动设置失败或您使用了其他客户端:
- 查找MCP客户端的配置文件。 (查看客户文件)。
- *克劳德示例(macOS):* ~/Library/Application Support/Claude/claude_desktop_config.json - *克劳德示例(Windows):* %APPDATA%\Claude\claude_desktop_config.json
- 编辑文件 添加/更新
mcpServers部分,使用 *精确* 从步骤1开始的路径。
Click for Client-Specific JSON Configuration Snippets...
______________________________________________________________________
克劳德代码
如果您使用的是Claude Code,则可以使用以下命令注册MCP服务器:
macOS:
claude mcp add --scope user UnityMCP -- uv --directory /Users/USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src run server.py窗户:
claude mcp add --scope user UnityMCP -- "C:/Users/USERNAME/AppData/Local/Microsoft/WinGet/Links/uv.exe" --directory "C:/Users/USERNAME/AppData/Local/UnityMCP/UnityMcpServer/src" run server.pyVSCode(所有操作系统)
{
"servers": {
"unityMCP": {
"command": "uv",
"args": ["--directory","/UnityMcpServer/src","run","server.py"],
"type": "stdio"
}
}
}在Windows上,设置 command 绝对垫片,例如。 C:\\Users\\YOU\\AppData\\Local\\Microsoft\\WinGet\\Links\\uv.exe.
窗户:
{
"mcpServers": {
"UnityMCP": {
"command": "uv",
"args": [
"run",
"--directory",
"C:\\Users\\YOUR_USERNAME\\AppData\\Local\\UnityMCP\\UnityMcpServer\\src",
"server.py"
]
}
// ... other servers might be here ...
}
}(记得替换YOUR_USERNAME并使用双反斜杠\\)
macOS:
{
"mcpServers": {
"UnityMCP": {
"command": "uv",
"args": [
"run",
"--directory",
"/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src",
"server.py"
]
}
// ... other servers might be here ...
}
}(替换YOUR_USERNAME。注意:AppSupport是指向“应用程序支持”的符号链接,以避免引用问题)
Linux:
{
"mcpServers": {
"UnityMCP": {
"command": "uv",
"args": [
"run",
"--directory",
"/home/YOUR_USERNAME/.local/share/UnityMCP/UnityMcpServer/src",
"server.py"
]
}
// ... other servers might be here ...
}
}(替换YOUR_USERNAME)
______________________________________________________________________
用法▶️
- 打开你的Unity项目。 Unity软件包的MCP应自动连接。通过Unity的窗口>MCP检查状态。
- 启动您的MCP客户端 (克劳德、Cursor等)。它应该使用安装步骤2中的配置自动启动Unity Server(Python)的MCP。
- 互动! Unity工具现在应该可以在您的MCP客户端中使用。
示例提示: Create a 3D player controller, Create a tic-tac-toe game in 3D, Create a cool shader and apply to a cube.
使用多个Unity实例
MCP for Unity同时支持多个Unity编辑器实例。每个MCP客户端会话都隔离了每个实例。
要将工具调用定向到特定实例,请执行以下操作:
- 列出可用实例:请您的LLM检查
unity_instances资源 - 设置活动实例:使用
set_active_instance使用实例名称(例如。,MyProject@abc123) - 所有后续工具都会路由到该实例,直到发生更改
例子:
User: "List all Unity instances"
LLM: [Shows ProjectA@abc123 and ProjectB@def456]
User: "Set active instance to ProjectA@abc123"
LLM: [Calls set_active_instance("ProjectA@abc123")]
User: "Create a red cube"
LLM: [Creates cube in ProjectA]______________________________________________________________________
发展与贡献🛠️
开发设置和指南
看 README-DEV.md 用于完整的开发设置和工作流文档。
添加自定义工具
MCP for Unity使用与Unity的C#脚本绑定的Python MCP服务器作为工具。如果您想使用自己的工具扩展功能,请在中学习如何操作 CUSTOM_TOOLS.md.
如何做出贡献
- 分叉 主存储库。
- 创建问题 讨论你的想法或bug。
- 创建分支 (
feature/your-idea或bugfix/your-fix). - 进行更改。
- 提交 (壮举:添加酷炫的新功能)。
- 推 你的分支。
- 打开拉取请求 针对主分支,引用您之前创建的问题。
______________________________________________________________________
📊 遥测和隐私
Unity的MCP包括 注重隐私的匿名遥测 帮助我们改进产品。我们收集使用分析和性能数据,但是 从不 您的代码、项目名称或个人信息。
- 🔒 匿名:仅随机UUID,无个人数据
- 🚫 轻松选择退出:设置
DISABLE_TELEMETRY=true环境变量 - 📖 透明:参见 遥测.md 有关完整详细信息
您的隐私对我们很重要。所有遥测都是可选的,旨在尊重您的工作流程。
______________________________________________________________________
故障排除❓
Click to view common issues and fixes...
- Unity网桥未运行/连接:
- 确保Unity编辑器已打开。 - 检查状态窗口:Unity的窗口>MCP。 - 重新启动Unity。
- MCP客户端未连接/服务器未启动:
- 验证服务器路径: 仔细检查MCP客户端JSON配置中的--目录路径。它必须与安装位置完全匹配: - 窗户: %USERPROFILE%\AppData\Local\UnityMCP\UnityMcpServer\src - macOS: ~/Library/AppSupport/UnityMCP/UnityMcpServer\src - Linux: ~/.local/share/UnityMCP/UnityMcpServer\src - 验证紫外线: 确保 uv 已安装并工作(uv --version). - 手动运行: 尝试直接从终端运行服务器以查看错误:
cd /path/to/your/UnityMCP/UnityMcpServer/src
uv run server.py- 配置失败:
- 使用手动配置步骤。该插件可能缺乏写入MCP客户端配置文件的权限。
______________________________________________________________________
许可证📜
MIT许可证。看 许可证 文件。
______________________________________________________________________
Coplay的Unity AI工具
Coplay为Unity提供2个AI工具
- MCP for Unity 根据MIT许可证免费提供。
- 科普利 是Unity内部的高级Unity AI助手,它不仅仅是Unity的MCP。
(这些工具有不同的技术栈。请参阅这篇博客文章 Coplay与MCP for Unity的比较.)
免责声明
该项目是Unity Editor的免费开源工具,与Unity Technologies无关。
