通过模型上下文协议将Unity编辑器与大型语言模型连接起来
Unity MCP充当桥梁,让AI助手(如Claude、Cursor)能够通过本地MCP(模型上下文协议)客户端直接与Unity编辑器交互。赋予您的大型语言模型工具管理资产、控制场景、编辑脚本以及在Unity中自动化任务的能力。
您的大型语言模型可以使用以下函数:
read_console
:从控制台获取消息或清空控制台。manage_script
:管理C#脚本(创建、读取、更新、删除)。manage_editor
:控制和查询编辑器的状态和设置。manage_scene
:管理场景(加载、保存、创建、获取层次结构等)。manage_asset
:执行资产操作(导入、创建、修改、删除等)。manage_gameobject
:管理游戏对象:创建、修改、删除、查找和组件操作。execute_menu_item
:通过其路径执行菜单项(例如,“文件/保存项目”)。Unity MCP使用两个组件连接您的工具:
流程: [您的大型语言模型通过MCP客户端] <-> [Unity MCP服务器(Python)] <-> [Unity MCP桥接器(Unity编辑器)]
注意: 随着我们更新包,设置过程不断改进。如果遇到问题,请随时回来查看。
pip install uv
# 或者查看:https://docs.astral.sh/uv/getting-started/installation/

窗口 > 包管理器
。+
-> 从git URL添加包...
。https://github.com/justinpbarnett/unity-mcp.git?path=/UnityMcpBridge
添加
。将您的MCP客户端(Claude、Cursor等)连接到步骤1中安装的Python服务器。
选项A:自动配置(推荐用于Claude/Cursor)
窗口 > Unity MCP
。自动配置Claude
或自动配置Cursor
。选项B:手动配置
如果自动配置失败或您使用其他客户端:
~/Library/Application Support/Claude/claude_desktop_config.json
%APPDATA%\Claude\claude_desktop_config.json
mcpServers
部分,使用步骤1中的精确路径。Windows:
{
"mcpServers": {
"UnityMCP": {
"command": "uv",
"args": [
"run",
"--directory",
"C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Programs\\UnityMCP\\UnityMcpServer\\src",
"server.py"
]
}
// ... 其他服务器可能在这里 ...
}
}

(请记住替换YOUR_USERNAME并使用双反斜杠\)
macOS:
{
"mcpServers": {
"UnityMCP": {
"command": "uv",
"args": [
"run",
"--directory",
"/usr/local/bin/UnityMCP/UnityMcpServer/src",
"server.py"
]
}
// ... 其他服务器可能在这里 ...
}
}

(如果使用~/bin,请替换YOUR_USERNAME)
Linux:
{
"mcpServers": {
"UnityMCP": {
"command": "uv",
"args": [
"run",
"--directory",
"/home/YOUR_USERNAME/bin/UnityMCP/UnityMcpServer/src",
"server.py"
]
}
// ... 其他服务器可能在这里 ...
}
}

(替换YOUR_USERNAME)
打开您的Unity项目。 Unity MCP桥接器(包)应自动连接。通过窗口 > Unity MCP检查状态。
启动您的MCP客户端(Claude、Cursor等)。它应使用安装步骤3中的配置自动启动Unity MCP服务器(Python)。
交互! Unity工具现在应该可以在您的MCP客户端中使用。
示例提示:创建一个3D玩家控制器。
帮助改进Unity MCP!
分叉主仓库。
创建分支(feature/your-idea
或bugfix/your-fix
)。
进行更改。
提交(feat: 添加很棒的新功能)。
推送您的分支。
针对主分支打开拉取请求。
Unity桥接器未运行/连接:
确保Unity编辑器已打开。
检查状态窗口:窗口 > Unity MCP。
重新启动Unity。
MCP客户端未连接/服务器未启动:
验证服务器路径: 仔细检查您的MCP客户端JSON配置中的--directory路径。它必须与安装步骤1中克隆UnityMCP仓库的位置完全匹配(例如,.../Programs/UnityMCP/UnityMcpServer/src)。
验证uv: 确保uv已安装并正常工作(pip show uv)。
手动运行: 尝试直接从终端运行服务器以查看错误:# 首先导航到src目录! cd /path/to/your/UnityMCP/UnityMcpServer/src uv run server.py
权限(macOS/Linux): 如果您将服务器安装在系统位置(如/usr/local/bin),请确保运行MCP客户端的用户具有执行uv和访问那里文件的权限。安装在~/bin可能更容易。
自动配置失败:
仍然卡住?打开问题。
MIT许可证。查看LICENSE文件。
感谢贡献者和Unity团队。