Skip to main content
Glama
dsh18235538266-crypto

onshape-mcp-codex

create_sketch_circle

Create a circular sketch on a plane or face in an Onshape Part Studio, defining center and radius. Optionally drive dimensions with parametric variables for later edits.

Instructions

Create a circular sketch. Pass either plane (Front/Top/Right) or faceId (from list_entities) to choose the sketch surface. faceId wins when both are given.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoSketch nameSketch
planeNoStandard datum plane. Defaults to Front if neither plane nor faceId is given.
centerNoCenter point [x, y]. Bare numbers are mm; use "10 mm" / "0.5 in" for explicit units. Preferred over centerX/centerY.
faceIdNoDeterministic ID of an existing face to sketch on (get from `list_entities`). Mutually exclusive with `plane`; wins if both given.
radiusYesRadius. Bare=mm; use "5 mm" / "0.125 in" for explicit units.
centerXNoCenter X (bare=mm). Legacy; prefer `center`.
centerYNoCenter Y (bare=mm). Legacy; prefer `center`.
elementIdYesPart Studio element ID
documentIdYesDocument ID
workspaceIdYesWorkspace ID
variableCenterNoOptional [x_var, y_var] variable names. Emits HORIZONTAL + VERTICAL DISTANCE constraints from the sketch origin to the circle center, driven by `#x_var` / `#y_var`.
variableRadiusNoOptional variable-table name to drive the radius parametrically. Emits a RADIUS dimensional constraint with expression `#<name>` so a later set_variable call resizes the hole without touching this sketch.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior2/5

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

With no annotations, the description carries full responsibility for behavioral disclosure. It only restates the faceId-wins precedence and the list_entities source, both of which already appear in the input schema. It does not mention whether the tool creates a new sketch or adds to an existing one, what it returns, or other side effects such as variable constraints beyond the schema descriptions.

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 three short sentences with the core purpose front-loaded, followed by surface-selection guidance and the precedence rule. There is no filler or unnecessary prose; the structure makes the most important information immediately visible.

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 rich schema covers all 12 parameters, defaults, units, and legacy fields, so invocation details are well supported. However, with no output schema and no annotations, the description omits tool-selection context versus other sketch creators, the return value, and whether the circle is created in a new sketch or an existing one. These are moderate gaps, but the schema prevents the definition from being inadequate.

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% and the parameter descriptions are detailed, covering defaults, units, legacy alternatives, and variable-driven behavior. The description adds no new parameter meaning—it rephrases the plane/faceId relationship already documented in the schema. Therefore the baseline of 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 first sentence, 'Create a circular sketch,' clearly states the verb (create) and resource (circular sketch), and the word 'circular' differentiates it from sibling rectangle, line, and arc sketch tools. The surface-selection instruction reinforces what the tool operates on. The core function is unambiguous.

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

Usage Guidelines3/5

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

The description gives no explicit comparison to siblings such as create_sketch_rectangle, create_sketch_line, or generic create_sketch, so tool selection is left mostly to inference from the name. It does provide within-tool guidance on choosing plane vs faceId, which is useful but is not the same as saying when to use this tool instead of alternatives. Usage context is implied, not explicit.

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