Skip to main content
Glama
dsh18235538266-crypto

onshape-mcp-codex

compare_to_reference

Render current Part Studio views and composite them with a reference image into a single side-by-side PNG to visually cross-check proportions and feature placement against the brief.

Instructions

Render your current Part Studio at iso/top/front/right and COMPOSITE the result directly under a reference image from disk. Returns a single side-by-side PNG: reference on top, your build's 4 views on the bottom row, both at the same horizontal extent so silhouettes line up visually. Use this whenever you want to cross-check feature count / placement / proportion against the brief's reference figure — it removes the need to squint back and forth across separate images. The reference path you pass is a filesystem path readable by the MCP server (typically the brief's iso or drawing PNG).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viewsNoViews to render for the agent row. Default: iso,top,front,right.
widthNo
heightNo
elementIdYes
documentIdYes
workspaceIdYes
referenceImagePathYesAbsolute or cwd-relative filesystem path to the reference PNG.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and discloses meaningful behavior: it renders four views, composites them below the reference, aligns horizontal extents, and notes that the reference path must be readable by the MCP server. It leaves minor gaps such as exact return delivery format and side effects, but the core behavioral contract is clearly exposed.

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?

The description is four sentences, each earning its place: it states the operation, the output layout, the alignment guarantee, the intended use case, and the path constraint. It is front-loaded with the core verb and output before adding supporting detail, with no filler.

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

Completeness3/5

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

The description is solid for a moderately complex compositing tool, but with no output schema and no annotations, an agent still lacks some critical context: how the returned PNG is surfaced, how width/height affect the composite, and what happens if the reference file does not exist. The layout and use case are clear, but the return contract and edge behaviors are underspecified.

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 low at 29%, so the description must compensate. It adds useful meaning for referenceImagePath ('filesystem path readable by the MCP server') and for views by naming the defaults, and it implies that documentId/workspaceId/elementId identify the current Part Studio. However, width, height, and the three ID parameters remain largely unexplained in both schema and description.

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 states a highly specific action: render the current Part Studio in four named views and composite them under a reference image. It also names the exact output, a single side-by-side PNG, which clearly differentiates it from standalone rendering tools like render_part_studio_views and from plain load_local_image.

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?

The description gives a clear when-to-use scenario: 'Use this whenever you want to cross-check feature count / placement / proportion against the brief's reference figure.' It does not explicitly name alternatives or state when not to use the tool, but the intended context is unambiguous enough for an agent to route itself.

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