Skip to main content
Glama
dsh18235538266-crypto

onshape-mcp-codex

create_revolute_mate

Create a revolute mate between two assembly instances by specifying face IDs. Set rotation limits and optional connector offsets to define how one instance rotates around the other.

Instructions

Create a revolute (rotation) mate between two assembly instances. The first instance rotates relative to the second around the mate connector Z-axis. Requires face IDs from Part Studio body details. Optional offsets shift connectors from face centers.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoMate nameRevolute mate
maxLimitNoOptional maximum rotation limit in degrees
minLimitNoOptional minimum rotation limit in degrees
elementIdYesAssembly element ID
documentIdYesDocument ID
firstFaceIdYesFace deterministic ID on the first instance
workspaceIdYesWorkspace ID
firstOffsetXNoFirst connector X offset. Bare numbers = mm; strings like "10 mm" / "0.5 in" respected.
firstOffsetYNoFirst connector Y offset. Bare = mm; unit-strings respected.
firstOffsetZNoFirst connector Z offset. Bare = mm; unit-strings respected.
secondFaceIdYesFace deterministic ID on the second instance
secondOffsetXNoSecond connector X offset. Bare = mm; unit-strings respected.
secondOffsetYNoSecond connector Y offset. Bare = mm; unit-strings respected.
secondOffsetZNoSecond connector Z offset. Bare = mm; unit-strings respected.
firstInstanceIdYesFirst instance ID
secondInstanceIdYesSecond instance ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It clearly implies a mutating action ('Create'), but does not disclose potential side effects (e.g., whether it replaces existing mates), authentication requirements, or rate limits. The core behavior is transparent enough for a create action, but additional details are lacking.

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 succinct, using only three sentences to convey the core purpose, requirements, and offset behavior. No redundant information is present, and the structure is easy to parse.

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?

Given the complexity (16 parameters, 7 required), the description covers essential context: it notes the need for face IDs, explains offset behavior, and implies assembly modification. It does not elaborate on return values or how to obtain face IDs, but with 100% schema coverage and no output schema, these omissions are acceptable.

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

Parameters5/5

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

Schema coverage is 100% with every parameter having a description. The description adds valuable semantic details beyond the schema, especially for offset parameters ('Bare numbers = mm; strings like "10 mm" / "0.5 in" respected'), which clarifies unit handling and prevents misuse.

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 ('Create'), the resource ('a revolute mate'), and the constraint behavior ('first instance rotates relative to the second around the mate connector Z-axis'). It effectively distinguishes this from sibling mate tools like create_fastened_mate and create_slider_mate by specifying the rotational nature.

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 provides some usage context, such as requiring face IDs from Part Studio body details and explaining that offsets shift connectors. However, it does not explicitly mention when to use this tool versus alternative mate types (e.g., slider or cylindrical mates), leaving selection partially to inference.

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