get_viewport_screenshot
Capture screenshots of the Blender 3D viewport to document your scene, share progress, or create reference images for AI-assisted modeling workflows.
Instructions
Capture a screenshot of the current Blender 3D viewport.
Parameters:
- max_size: Maximum size in pixels for the largest dimension (default: 800)
Returns the screenshot as an Image.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_size | No |
Implementation Reference
- src/blender_mcp/server.py:275-316 (handler)The main handler function for the 'get_viewport_screenshot' tool. It connects to Blender, sends a command to capture the viewport screenshot to a temporary file, reads the image bytes, and returns an MCP Image object.
@mcp.tool() def get_viewport_screenshot(ctx: Context, max_size: int = 800) -> Image: """ Capture a screenshot of the current Blender 3D viewport. Parameters: - max_size: Maximum size in pixels for the largest dimension (default: 800) Returns the screenshot as an Image. """ try: blender = get_blender_connection() # Create temp file path temp_dir = tempfile.gettempdir() temp_path = os.path.join(temp_dir, f"blender_screenshot_{os.getpid()}.png") result = blender.send_command("get_viewport_screenshot", { "max_size": max_size, "filepath": temp_path, "format": "png" }) if "error" in result: raise Exception(result["error"]) if not os.path.exists(temp_path): raise Exception("Screenshot file was not created") # Read the file with open(temp_path, 'rb') as f: image_bytes = f.read() # Delete the temp file os.remove(temp_path) return Image(data=image_bytes, format="png") except Exception as e: logger.error(f"Error capturing screenshot: {str(e)}") raise Exception(f"Screenshot failed: {str(e)}") - src/blender_mcp/server.py:275-275 (registration)The @mcp.tool() decorator registers the get_viewport_screenshot function as an MCP tool.
@mcp.tool()