Skip to content

vitthalr/blender-mcp-github-copilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 

Repository files navigation

BlenderMCP - Blender Model Context Protocol Integration

BlenderMCP connects Blender to GitHub Copilot through the Model Context Protocol (MCP), allowing GitHub Copilot to directly interact with and control Blender. This integration enables prompt-assisted 3D modeling, scene creation, and manipulation.

Table of Contents

Installation

Prerequisites

macOS Installation

If you're on a Mac, please open Terminal and run the following commands one by one:

1. Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then configure Homebrew:

echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zshrc
eval "$(/opt/homebrew/bin/brew shellenv)"

2. Install Python

brew install python

3. Install UV

brew install uv

Windows Installation

If you're on Windows, please open PowerShell and run the following commands one by one:

1. Install Python

winget install -e --id Python.Python.3.11

2. Install UV

powershell -c "irm https://astral.sh/uv/install.ps1 | iex" 

Then add UV to your PATH:

$env:Path = "C:\Users\$env:USERNAME\.local\bin;$env:Path"

For other operating systems, installation instructions are available on the UV website: Install UV

Installing the Blender Addon

  1. Download the addon.py file from this link and save it to your computer
  2. Open Blender
  3. Go to Edit > Preferences > Add-ons
  4. Click "Install..." and select the saved addon.py file
  5. Enable the addon by checking the box next to "Interface: Blender MCP"

GitHub Copilot Integration

Go to Visual Studio Code:

  1. Press Cmd + Shift + P (macOS) or Ctrl + Shift + P (Windows/Linux)
  2. Select MCP: Add Server
  3. Select "Command (Stdio)" and enter command uvx blender-mcp
  4. Add a unique identifier such as mcpServer
  5. Open Copilot chat in Visual Studio Code and start prompting!

After setup, your settings.json should contain something like this:

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

Capabilities

BlenderMCP allows GitHub Copilot to:

  • Get scene and object information
  • Create, delete, and modify 3D shapes
  • Apply or create materials for objects
  • Execute any Python code in Blender
  • Download models, assets, and HDRIs through Poly Haven
  • Generate AI-powered 3D models through Hyper3D Rodin

Example Commands

Here are some examples of what you can ask GitHub Copilot to do:

  • "Create a low poly scene in a dungeon, with a dragon guarding a pot of gold" - Demo
  • "Create a beach vibe using HDRIs, textures, and models like rocks and vegetation from Poly Haven" - Demo
  • "Given this reference image, create a Blender scene that matches it" - Demo
  • "Generate a 3D model of a garden gnome through Hyper3D"
  • "Get information about the current scene, and make a three.js sketch from it" - Demo
  • "Make this car red and metallic"
  • "Create a sphere and place it above the cube"
  • "Make the lighting look like a professional studio"
  • "Point the camera at the scene, and make it isometric"

Limitations & Security Considerations

  • The execute_blender_code tool allows running arbitrary Python code in Blender, which can be powerful but potentially dangerous. Use with caution in production environments. ALWAYS save your work before using it.
  • Poly Haven requires downloading models, textures, and HDRI images. If you do not want to use this feature, you can disable it in the Blender MCP addon's preferences panel within Blender (Edit > Preferences > Add-ons > Interface: Blender MCP).
  • Complex operations might need to be broken down into smaller steps for best results.

Disclaimer

This is a third-party integration and not officially made or endorsed by Blender. Developed by Siddharth.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors