使用说明

项目简介

BlenderMCP 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在桥接 Blender 这一强大的 3D 建模软件与大型语言模型 (LLM) 及 CSM.ai 的 3D 资源平台。通过 BlenderMCP,用户可以使用自然语言指令,借助 LLM 的理解和生成能力,以及 CSM.ai 丰富的 3D 模型库,在 Blender 中进行智能化的 3D 内容创作。

主要功能点

  • 资源访问: 集成 CSM.ai 平台,允许用户通过文本搜索访问 CSM.ai 公共或私有的 3D 模型资源库。
  • 工具调用: 提供基于文本提示的 3D 模型动画生成工具,用户可以通过简单的文本指令,为场景中的角色模型添加动画效果。
  • 场景操作: 支持通过 MCP 协议指令控制 Blender 场景,包括创建、修改、删除 3D 对象,设置材质,获取场景信息等。
  • 灵活配置: 通过 JSON 配置文件,可以轻松配置 MCP 服务器的启动方式,方便与各种 MCP 客户端(如 Cursor, Claude 等)集成。

安装步骤

  1. 克隆仓库: 从 GitHub 克隆 'blender-mcp' 仓库到本地。
    git clone https://github.com/CommonSenseMachines/blender-mcp.git
  2. 进入项目目录: 使用 'cd' 命令切换到项目根目录。
    cd blender-mcp
  3. 安装 Python 包: 使用 'pip' 安装项目依赖。
    pip install -e .
    如果遇到问题,可以尝试升级 'pip' 或使用 'python3.10 -m pip install -e .' 命令。

服务器配置

为了让 MCP 客户端(如 Cursor)连接到 BlenderMCP 服务器,您需要配置客户端的 MCP 设置。以下是一个 '.mcp.json' 文件的示例配置,您需要将其添加到 MCP 客户端的配置中。

{
    "mcpServers": {
        "blender": {
            "command": "python",
            "args": [
                "-m", "blender_mcp.server"
            ]
        }
    }
}

配置参数说明:

  • '"blender"': 服务器名称,可以自定义。
  • '"command"': 启动 MCP 服务器的命令,这里使用 'python' 解释器。
  • '"args"': 传递给 'python' 命令的参数,'-m blender_mcp.server' 指定运行 'blender_mcp.server' 模块作为服务器。

Cursor 配置步骤:

  1. 在 Cursor 中打开 'blender-mcp' 仓库的根目录。
  2. 打开 Cursor 设置 ('Cursor → Settings → Cursor Settings')。
  3. 找到 MCP 设置 ('MCP') 并点击 "Add a new server"。
  4. 将上述 JSON 配置粘贴到 MCP 服务器配置中。

Blender 配置步骤:

  1. 启动 Blender 软件。
  2. 打开 Blender 偏好设置 ('Edit → Preferences')。
  3. 在 "Add-ons" 选项卡中,点击 "Install..." 并选择 'addon.py' 文件(位于克隆的 'blender-mcp' 仓库中)。
  4. 启用 "Blender MCP" 插件。
  5. 在 Blender 侧边栏找到 "BlenderMCP" 面板,点击 "Start MCP Server" 按钮启动服务器。
  6. 如果您希望使用 CSM.ai 功能,请勾选 "Use CSM.ai 3D models" 并输入您的 CSM API 密钥。

基本使用方法

  1. 确保 BlenderMCP 服务器已在 Blender 中启动,并且 MCP 客户端(如 Cursor)已正确配置并连接到服务器。
  2. 在 MCP 客户端的聊天窗口中,可以使用自然语言指令来控制 Blender 场景。例如:
    • '创建一个立方体'
    • '将名为 "Cube" 的物体移动到坐标 (1, 2, 3)'
    • '从 CSM.ai 搜索椅子模型并导入场景'
    • '为名为 "Robot" 的模型添加跳舞动画'
    • '获取当前场景的信息'
  3. 您可以参考 'README.md' 文件中的快速开始示例,体验如何通过文本指令在 Blender 中创建场景和模型。

重要提示:

  • 确保 Blender 软件已安装并正确配置。
  • 使用 CSM.ai 功能需要有效的 API 密钥,请访问 3d.csm.ai 获取。
  • 动画生成功能可能需要较长时间,请耐心等待。

信息

分类

桌面与硬件