cuBe (Blender) MCP server

This MCP server allows for bidirectional communication between Blender and AI assistants like Cursor AI through the Model Context Protocol. It enables AI to programmatically control Blender, creating and manipulating 3D objects through a socket connection.

Installation

Prerequisites

• Python 3.6 or later
• Blender 2.80 or later

Automatic Installation

Windows

1. Download or clone the repository
2. Double-click install.bat
3. Follow the installer prompts

macOS/Linux

1. Download or clone the repository
2. Open Terminal and navigate to the repository folder
3. Make the install script executable: chmod +x install.sh
4. Run the installer: ./install.sh
5. Follow the installer prompts

Manual Installation

If the automatic installer doesn't work:

1. Copy addon.py to your Blender addons directory:

   • Windows: C:\Program Files\Blender Foundation\Blender\[version]\scripts\addons\
   • macOS: /Applications/Blender.app/Contents/Resources/scripts/addons/ or ~/Library/Application Support/Blender/[version]/scripts/addons/
   • Linux: /usr/share/blender/scripts/addons/ or ~/.config/blender/scripts/addons/

2. Rename the file to blendermcp.py

3. Enable the addon in Blender:

   • Go to Edit > Preferences > Add-ons
   • Search for "BlenderMCP"
   • Check the box to enable it

Usage

Basic Setup

1. Start Blender after installation
2. In the 3D Viewport, press N to open the sidebar
3. Find the "BlenderMCP" tab
4. Click "Start MCP Server" to start the server on the default port (9876)
5. Connect to the server from Cursor AI or other MCP clients

Advanced Features

Viewport Capture

Capture the current viewport as an image with the get_viewport_image command:

{
    "type": "get_viewport_image",
    "params": {
        "width": 512,
        "height": 512,
        "format": "JPEG"
    }
}

Scene Metrics

Get detailed performance and scene statistics from Blender:

{
    "type": "get_scene_metrics",
    "params": {}
}

This returns information about polygon count, objects, memory usage, and more.

Live Preview

Stream continuous viewport updates in real-time:

{
    "type": "start_live_preview",
    "params": {
        "port": 9877,
        "fps": 10
    }
}

This starts a separate server for receiving continuous viewport updates.

Testing the Connection

The installer automatically tests the connection by creating a sphere above the default cube. If you see a sphere appear, the installation was successful!

You can also run the included test scripts:

• test_blendermcp.py - Basic connection test
• test_viewport.py - Test advanced viewport and metrics features

Integration with Cursor AI

To configure Cursor:

1. Open Cursor Settings
2. Navigate to MCP settings
3. Add the BlenderMCP command: uvx blender-mcp

Troubleshooting

• Port already in use: Change the port in the BlenderMCP panel in Blender
• Addon not found: Verify the addon is properly installed and enabled
• Connection failed: Check that the server is running and not blocked by a firewall
• Viewport capture issues: Ensure you have a 3D viewport area in Blender
• Live preview not working: Check if another service is using the specified preview port

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "cube" '{"command":"uvx","args":["blender-mcp"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cube": {
            "command": "uvx",
            "args": [
                "blender-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "cube": {
            "command": "uvx",
            "args": [
                "blender-mcp"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect