Skip to main content
Glama
gpambrozio

onshape-mcp

by gpambrozio

Render the model

onshape_shaded_view

Generate an on-demand shaded image of a CAD element to verify current geometry before exporting.

Instructions

Render the element server-side and return the image. Unlike a thumbnail this is generated on demand, so it always shows the current geometry — use it to check a model visually before exporting.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
wsYesWorkspace id — the <ws> segment of the document URL.
docYesDocument id — the <doc> in cad.onshape.com/documents/<doc>/w/<ws>/e/<elem>.
outNoOutput PNG path (default onshape-<timestamp>.png in the output directory).
elemYesElement id (tab) — the <elem> segment of the document URL.
kindNoElement kind being exported (default partstudios).
widthNoImage width in pixels (default 600).
heightNoImage height in pixels (default 340).
no_edgesNoHide edges in the render.
view_matrixNo3x4 row-major camera matrix as 12 comma-separated numbers (default isometric).
return_imageNoAlso return the PNG inline (default true).
configurationNoEncoded configuration string.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations provide only a title, so the description must carry the behavioral burden. It discloses that rendering is server-side, on-demand, and shows current geometry. However, it does not mention that it may write a file to disk via the 'out' parameter, nor does it discuss authentication requirements or side effects. This is adequate but leaves some behavioral gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no wasted words. The core purpose is front-loaded, and the alternative (thumbnail) is mentioned immediately. The usage hint is concise and actionable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a render tool with 11 parameters and no output schema, the description covers the essential usage and distinguishes it from thumbnails. It does not explain advanced parameters like 'configuration' or 'view_matrix', but these are self-explanatory in the schema. The tool's complexity is moderate, and the description is adequately complete for typical use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all 11 parameters. The description adds no additional meaning beyond the schema, such as how the 'view_matrix' should be formatted or when to set 'return_image' to false. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Render the element server-side and return the image') and names the resource (element). It explicitly differentiates from thumbnails by emphasizing on-demand generation and current geometry, which distinguishes it from sibling tools like onshape_get_thumbnail.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides a clear use case ('use it to check a model visually before exporting') and contrasts with thumbnails. It does not explicitly mention when not to use it or other alternatives (e.g., export tools), but the context is sufficient for an agent to understand its primary purpose.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools