首页
学习
活动
专区
圈层
工具
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
首页
学习
活动
专区
圈层
工具
MCP广场
MCP广场 >详情页
unity-mcp2025-05-270分享
github
基于模型上下文协议,搭建起 Unity 与大型语言模型间的无缝通信桥梁。它助力开发人员自动化工作流,可对资源进行操作,还能以编程方式控制 Unity 编辑器,优化开发流程。
By justinpbarnett
2025-05-270
github
详情内容

Unity MCP ✨

通过模型上下文协议将Unity编辑器与大型语言模型连接起来

Unity MCP充当桥梁,让AI助手(如Claude、Cursor)能够通过本地MCP(模型上下文协议)客户端直接与Unity编辑器交互。赋予您的大型语言模型工具管理资产、控制场景、编辑脚本以及在Unity中自动化任务的能力。


UnityMCP工作流程

核心功能 🚀

  • 🗣️ 自然语言控制: 指示您的大型语言模型执行Unity任务。
  • 🛠️ 强大工具: 管理资产、场景、材质、脚本和编辑器功能。
  • 🤖 自动化: 自动化重复的Unity工作流程。
  • 🧩 可扩展: 设计用于与各种MCP客户端配合使用。
展开查看可用工具...

您的大型语言模型可以使用以下函数:

  • read_console:从控制台获取消息或清空控制台。
  • manage_script:管理C#脚本(创建、读取、更新、删除)。
  • manage_editor:控制和查询编辑器的状态和设置。
  • manage_scene:管理场景(加载、保存、创建、获取层次结构等)。
  • manage_asset:执行资产操作(导入、创建、修改、删除等)。
  • manage_gameobject:管理游戏对象:创建、修改、删除、查找和组件操作。
  • execute_menu_item:通过其路径执行菜单项(例如,“文件/保存项目”)。

工作原理 🤔

Unity MCP使用两个组件连接您的工具:

  1. Unity MCP桥接器: 运行在编辑器内部的Unity包。(通过Package Manager安装)。
  2. Unity MCP服务器: 本地运行的Python服务器,在Unity桥接器和您的MCP客户端之间通信。(手动安装)。

流程: [您的大型语言模型通过MCP客户端] <-> [Unity MCP服务器(Python)] <-> [Unity MCP桥接器(Unity编辑器)]


安装 ⚙️

注意: 随着我们更新包,设置过程不断改进。如果遇到问题,请随时回来查看。

前提条件

点击查看所需软件...
  • Git CLI: 用于克隆服务器代码。下载Git
  • Python: 3.12或更高版本。下载Python
  • Unity Hub和编辑器: 2020.3 LTS或更高版本。下载Unity
  • uv(Python包管理器):
    pip install uv
    # 或者查看:https://docs.astral.sh/uv/getting-started/installation/
    
  • 一个MCP客户端:

步骤1:安装Unity包(桥接器)

  1. 打开您的Unity项目。
  2. 转到窗口 > 包管理器
  3. 点击+ -> 从git URL添加包...
  4. 输入:
    https://github.com/justinpbarnett/unity-mcp.git?path=/UnityMcpBridge
    
  5. 点击添加
  6. 作为此过程的结果,MCP服务器应自动安装到您的计算机上。

步骤2:配置您的MCP客户端

将您的MCP客户端(Claude、Cursor等)连接到步骤1中安装的Python服务器。

选项A:自动配置(推荐用于Claude/Cursor)

  1. 在Unity中,转到窗口 > Unity MCP
  2. 点击自动配置Claude自动配置Cursor
  3. 查找绿色状态指示器🟢和“已连接”。(这会尝试自动修改MCP客户端的配置文件)

选项B:手动配置

如果自动配置失败或您使用其他客户端:

  1. 找到您的MCP客户端的配置文件。(查看客户端文档)。
    • Claude示例(macOS): ~/Library/Application Support/Claude/claude_desktop_config.json
    • Claude示例(Windows): %APPDATA%\Claude\claude_desktop_config.json
  2. 编辑文件以添加/更新mcpServers部分,使用步骤1中的精确路径。
点击查看特定于操作系统的JSON配置片段...

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)


使用方法 ▶️

  1. 打开您的Unity项目。 Unity MCP桥接器(包)应自动连接。通过窗口 > Unity MCP检查状态。

  2. 启动您的MCP客户端(Claude、Cursor等)。它应使用安装步骤3中的配置自动启动Unity MCP服务器(Python)。

  3. 交互! Unity工具现在应该可以在您的MCP客户端中使用。

    示例提示:创建一个3D玩家控制器。


贡献 🤝

帮助改进Unity MCP!

  1. 分叉主仓库。

  2. 创建分支feature/your-ideabugfix/your-fix)。

  3. 进行更改。

  4. 提交(feat: 添加很棒的新功能)。

  5. 推送您的分支。

  6. 针对主分支打开拉取请求


故障排除 ❓

点击查看常见问题及解决方法...
  • 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可能更容易。

  • 自动配置失败:

    • 使用手动配置步骤。自动配置可能没有权限写入MCP客户端的配置文件。

仍然卡住?打开问题


许可证 📜

MIT许可证。查看LICENSE文件。


联系方式 👋


致谢 🙏

感谢贡献者和Unity团队。

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档