OpenSCAD

MCP server for OpenSCAD rendering

javascript

4

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "rahulgarg123-openscad-mcp": {
      "command": "node",
      "args": [
        "/path/to/openscad-mcp/dist/index.js"
      ],
      "env": {
        "OPENSCAD_BINARY": "/path/to/OpenSCAD/binary"
      }
    }
  }
}

You can render OpenSCAD code into PNG images without a GUI by using this MCP server. It exposes a simple, standardized interface to perform headless rendering with flexible camera options and cross-platform OpenSCAD integration, making it easy to automate 3D tasks in your workflows.

How to use

You interact with the server through an MCP client to request rendering of OpenSCAD code. Provide the OpenSCAD source, specify where you want the PNG saved, and optionally supply camera parameters to control the view. The server processes your request and returns a result indicating success and the location of the rendered image.

How to install

Prerequisites: Ensure you have the required runtime and rendering tool installed.

Install Node.js 18 or higher on your system.

Install OpenSCAD Nightly (dev) version from OpenSCAD.org.

Clone the MCP server repository and install dependencies, then build the project.

git clone https://github.com/rahulgarg123/openscad-mcp.git
cd openscad-mcp
npm install
npm run build

Configuration

The server can be configured to locate the OpenSCAD binary and to run as an MCP server locally. You can provide the path to the OpenSCAD executable via an environment variable to ensure the server finds OpenSCAD on your system.

// Example of an MCP server configuration exposed to your MCP client
{
  "mcpServers": {
    "openscad": {
      "command": "node",
      "args": ["/path/to/openscad-mcp/dist/index.js"],
      "env": {
        "OPENSCAD_BINARY": "/path/to/OpenSCAD/binary"
      }
    }
  }
}

Troubleshooting

If OpenSCAD cannot be found, verify the binary path and ensure the OPENSCAD_BINARY environment variable points to the correct executable. If you encounter permission errors when writing output files, confirm the output directory exists and is writable. If rendering times out, try simplifying the OpenSCAD code or adjust the timeout settings in your setup.

Notes and tips

The server supports headless OpenSCAD rendering with options to adjust the camera. It is designed to run cross-platform, with a configurable binary path to accommodate different operating systems.

Available tools

render_openscad

Renders OpenSCAD code to a PNG image file. You provide the OpenSCAD source, an output path, and optional camera parameters to control the view.