Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Circular pattern

circular_pattern

Repeat parts, features, or faces around an axis to create spokes, bolt holes, or wheel patterns. Pattern a feature so copies merge or cut as the original does.

Instructions

Repeat parts, features or faces around an axis (a wheel's spokes, bolt holes on a circle). Pattern the FEATURE that makes one spoke or hole (feature_ids) so the copies merge or cut as it does; pattern parts (part_ids) to get separate copies. Put the count in a variable ('#spokes') when it should be configurable. The default name shows the count ('Circular pattern x6'). The reply says what changed (parts, volume).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "document_id": "<document_id>",
      "element_id": "<element_id>",
      "count": "<count>",
      "axis": "<axis>"
    },
    "name": "circular_pattern"
  }
}

Input Schema

NameRequiredDescriptionDefault
axisYesThe axis to turn about: the ID of a cylindrical or conical face or of a circular or straight edge (from get_body_details), or 'sketch:<feature_id>' to use the construction line drawn in that sketch (create_sketch with a `line` shape and construction=true).
nameNo
angleNoTotal angle in degrees (default 360: a full circle, instances 360/count apart). With equal_spacing=false it is the angle BETWEEN instances.
countYesNumber of instances INCLUDING the original (2 or more), or an Onshape expression such as '#spokes' so a variable or configuration can drive it.
verifyNoMeasure the Part Studio before and after (two extra requests) and report what changed: part count and total volume, plus a warning when nothing changed (Onshape can accept a feature that does nothing). Set false to save requests.
face_idsNoRepeat these faces (IDs from get_body_details). Give exactly one of part_ids, feature_ids and face_ids.
part_idsNoRepeat these whole parts (IDs from list_parts). Give exactly one of part_ids, feature_ids and face_ids.
operationNoOnly for part_ids: 'new' makes each copy a separate part (default); 'add' merges the copies into existing parts; 'remove' cuts with them; 'intersect' keeps the overlap.new
element_idYesElement (tab) ID: the string after /e/ in the Onshape URL. Get it from get_document.
merge_withNoPart IDs the copies merge with when operation is 'add', 'remove' or 'intersect' (default: every part they touch).
document_idYesOnshape document ID: the 24-character hex string after /documents/ in the document URL. Get it from list_documents.
feature_idsNoRepeat these features (feature_id of an extrude or other feature, e.g. one spoke of a wheel); each copy merges the way the feature does. Give exactly one of part_ids, feature_ids and face_ids.
workspace_idNoWorkspace ID (the string after /w/ in the URL). Optional - defaults to the document's main workspace.
equal_spacingNoSpread the instances equally over `angle`.
opposite_directionNoTurn the other way.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.1/5.0
Behavior4/5

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

Beyond the annotations, the description explains that feature copies merge or cut like the source feature and that the reply reports what changed, including parts and volume. It also documents the default verify behavior and its extra requests, though it does not discuss permissions or broader side effects.

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 compact and front-loaded, starting with the core operation and then adding the most important distinctions in a logical order. Every sentence adds useful context for calling the tool, with no significant filler.

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 complex 15-parameter tool with an output schema and detailed annotations, the description covers the essential purpose, mode selection, verification behavior, and return-value reporting. Some parameters such as angle, equal_spacing, and opposite_direction rely entirely on schema documentation, but the description remains sufficient for correct invocation.

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

Parameters4/5

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

With schema coverage at 93%, the schema already documents most parameters, but the description adds meaningful semantics for the mutually exclusive feature_ids, part_ids, and face_ids modes. It also explains putting the count in an expression variable such as '#spokes', which helps users understand configurability beyond the raw schema.

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

Purpose4/5

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

The description gives a clear verb and resource: repeat parts, features, or faces around an axis, with concrete CAD examples like wheel spokes and bolt holes. It clearly distinguishes the three patterning modes, but it does not explicitly name or differentiate itself from the sibling linear_pattern tool.

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 gives clear guidance on when to use feature_ids versus part_ids, explaining that feature patterning merges or cuts like the original feature while part patterning creates separate copies. It does not explicitly cover when to choose this over a linear pattern or mirror, so usage guidance is strong but not exhaustive.

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