Sketchup Integration

🚀 SketchupMCP - SketchUp Model Context Protocol Integration

SketchupMCP connects SketchUp to Claude AI. Through the Model Context Protocol (MCP), it enables Claude to directly interact with and control SketchUp. This integration facilitates prompt-assisted 3D modeling, scene creation, and manipulation.

A big shout-out to Blender MCP for the inspiration and structure.

✨ Features

• Two-way Communication: Connects Claude to SketchUp via a TCP socket connection.
• Component Operations: Create, modify, delete, and transform components in SketchUp.
• Material Control: Apply and modify materials and colors.
• Scene Information: Retrieve detailed information about the current SketchUp scene.
• Selection Handling: Get and manipulate selected components.
• Ruby Code Execution: Execute arbitrary Ruby code directly in SketchUp for advanced operations.

📦 Components

The system consists of two main parts:

1. SketchUp Plugin: A SketchUp plugin that creates a TCP server to receive and execute commands within SketchUp.
2. MCP Server (sketchup_mcp/server.py): A Python server that implements the Model Context Protocol and connects to the SketchUp plugin.

📦 Installation

Python Package Management

We use uv. Run brew install uv.

SketchUp Plugin

1. Download or build the latest .rbz file.
2. In SketchUp, go to Window > Extension Manager.
3. Click "Install Extension" and select the downloaded .rbz file.
4. Restart SketchUp.

💻 Usage Examples

Start the Connection

1. In SketchUp, go to Extensions > SketchupMCP > Start Server.
2. The server will start on the default port (9876).
3. Make sure the MCP server is running.

Integrate with Claude

Configure Claude to use the MCP server by adding the following to the Claude configuration:

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

This will pull the latest PyPI version.

Once connected, Claude can interact with SketchUp using the following features:

Tools

• get_scene_info - Get information about the current SketchUp scene.
• get_selected_components - Get information about the currently selected components.
• create_component - Create a new component with specified parameters.
• delete_component - Delete a component from the scene.
• transform_component - Move, rotate, or scale a component.
• set_material - Apply a material to a component.
• export_scene - Export the existing scene to various formats.
• eval_ruby - Execute arbitrary Ruby code in SketchUp for advanced operations.

Example Commands

Here are some example operations that Claude can perform:

• "Create a simple house model with a roof and windows."
• "Select all components and get their information."
• "Make the selected components red."
• "Move the selected components up by 10 units."
• "Export the existing scene as a 3D model."
• "Use Ruby code to create a complex Arts and Crafts cabinet."

🚧 Troubleshooting

• Connection Issues: Ensure that both the SketchUp plugin server and the MCP server are running.
• Command Failures: Check the error messages in the Ruby console in SketchUp.
• Timeout Errors: Try simplifying the request or breaking it down into smaller steps.

🔧 Technical Details

Communication Protocol

The system uses a simple JSON-based protocol over TCP sockets:

• Commands are transmitted in a JSON structure.
• Responses contain a status code and a message.
• The Content-Length header is used to specify the data size.
• Supported HTTP methods: POST, GET, DELETE.

🤝 Contribution Guidelines

Contributions to SketchupMCP are welcome! Please refer to CONTRIBUTING.md to learn how to get involved.

📄 License

This project is governed by LICENSE.