Skip to main content
Glama
gpambrozio

onshape-mcp

by gpambrozio

Sketch a hooked sweep path

onshape_sketch_candy_cane_path

Creates a candy-cane-shaped sketch path (straight stem plus hooked arc) in an Onshape document, ready to use as a sweep path.

Instructions

Add a sketch of a straight stem joined to a hooked arc, approximated by segments — a ready-made path for onshape_sweep.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
xNoX position of the stem (default 0).
wsYesWorkspace id — the <ws> segment of the document URL.
docYesDocument id — the <doc> in cad.onshape.com/documents/<doc>/w/<ws>/e/<elem>.
elemYesElement id (tab) — the <elem> segment of the document URL.
nameNoFeature name shown in the tree (default "Candy cane centerline").
planeNoDefault plane to sketch on (default Front).
bottomNoY of the stem's bottom (default 0).
segmentsNoTotal segments used to approximate the path (default 24).
validateNoRe-read the feature list afterwards and fail if the feature regenerated with an error (default true).
hook_angleNoSweep of the hook in degrees (default 210).
hook_radiusYesRadius of the hook, inches.
straight_heightYesLength of the straight stem, inches.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior2/5

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

Annotations provide no behavioral hints beyond the title (no readOnlyHint, destructiveHint, etc.), so the description carries the full burden. It only says 'Add a sketch', which implies a mutation, but discloses nothing about side effects, permission requirements, or what happens on failure. The schema's 'validate' parameter hints at verification behavior, but that is not reinforced in the description. This is a notable gap for a creation tool.

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 a single concise sentence that front-loads the action and purpose. It contains no filler, and every clause earns its place by clarifying what is sketched and why.

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?

With 12 parameters and no output schema, the description is adequate but sparse. It mentions the intended downstream tool (onshape_sweep) and the approximation via segments, which helps, but it does not explain the overall workflow (e.g., that a sketch is added to an existing element) or what the tool returns. Since the schema covers parameter details, the description meets minimum viability but lacks richer context that would help an agent integrate it into a multi-step operation.

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 coverage is 100%, so all 12 parameters are already documented. The description adds a high-level notion of geometry ('straight stem', 'hooked arc') that maps to straight_height and hook_radius, but the schema already describes those fields. The description does not add relational information, defaults, or unit clarifications beyond what the schema provides, so it meets the baseline without exceeding it.

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 specific action ('Add a sketch'), describes the geometry precisely ('straight stem joined to a hooked arc'), and names its intended use ('a ready-made path for onshape_sweep'). This clearly distinguishes it from sibling sketch tools like onshape_sketch_circle or onshape_sketch_line, so an agent knows exactly what this tool creates.

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 explicitly positions the tool as a prerequisite for onshape_sweep, giving a clear usage context. It does not name alternatives or state when not to use it, but the mention of 'ready-made path for onshape_sweep' gives sufficient guidance for an agent to select it when building a candy-cane sweep path.

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