Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

add_mate

Adds a mate between two assembly references to constrain components, supporting coincident, concentric, parallel, perpendicular, tangent, distance, and angle mates.

Instructions

Add a mate in the active assembly between two references. Simple form: point1 / point2 are points in ASSEMBLY coordinates that lie on the component faces to mate, or plane1 / plane2 name assembly planes. Full form: ref1 / ref2 can also pick a face by component and face id (list_component_faces), a sketch point or segment of a component (list_component_sketches), a part's own plane, axis or origin, and anything on a part inside a sub-assembly (component path like 'Door-1/Slat-3'). An edge or vertex: {component, edge_id} or {component, vertex_id}, ids from list_component_faces with include ['edges', 'vertices']. mate_type: coincident, concentric, parallel, perpendicular, tangent, distance (value = distance) or angle (value = degrees). A distance between a flat face and a cylinder is measured to the cylinder's AXIS, not its surface: for a gap of 0.5 to a disc of radius 20, give 20.5. A distance mate with minimum and maximum is a LIMIT mate: the distance may sit anywhere in that range, so another mate (the drive) can move the part only between the two ends; a value outside the range is refused. The result states what was picked on each side (component, face id, type, normal or axis), which components moved, and where to.

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": {
      "mate_type": "<mate_type>"
    },
    "name": "add_mate"
  }
}

Input Schema

NameRequiredDescriptionDefault
flipNoPut the distance / angle on the other side
ref1NoWhat to pick. One of: {point} the face at an assembly point; {component, point} the face of that component at the point; {component, face_id} a face from list_component_faces; {component, edge_id or vertex_id} from list_component_faces(include); {component, sketch, point_id} or {component, sketch, segment_id} a sketch point or segment from list_component_sketches; {component, plane} / {component, axis} / {component, origin: true} the part's own plane, axis or origin; {plane} / {axis} / {origin: true} the assembly's own. A component inside a sub-assembly is named by its path, e.g. 'Door-1/Slat-3'.
ref2NoWhat to pick. One of: {point} the face at an assembly point; {component, point} the face of that component at the point; {component, face_id} a face from list_component_faces; {component, edge_id or vertex_id} from list_component_faces(include); {component, sketch, point_id} or {component, sketch, segment_id} a sketch point or segment from list_component_sketches; {component, plane} / {component, axis} / {component, origin: true} the part's own plane, axis or origin; {plane} / {axis} / {origin: true} the assembly's own. A component inside a sub-assembly is named by its path, e.g. 'Door-1/Slat-3'.
unitNoUnit for points and distance (mm, cm, m, inch or ft)
valueNoDistance for a distance mate, degrees for an angle mate
plane1NoInstead of point1: Front, Top, Right or an assembly plane name
plane2NoInstead of point2: Front, Top, Right or an assembly plane name
point1No
point2No
maximumNoWith mate_type distance: largest distance allowed
minimumNoWith mate_type distance: smallest distance allowed. Together with maximum this makes a LIMIT mate; value is where it starts.
alignmentNoWhether the two faces point the same way (aligned) or against each other (anti_aligned)closest
mate_typeYesKind of mate

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does deliver real behavioral detail: distance-to-axis measurement with a worked numerical example, limit-mate drive semantics, and refusal of out-of-range values. It does not disclose failure behavior (over-constrained assemblies, missing components) or any contextual prerequisites, so it is strong but not complete.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded and every sentence carries information, but the whole description is one dense run-on paragraph where the edge/vertex and sub-assembly path points are repeated, making it harder to scan than it needs to be.

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 13-parameter nested tool with no output schema, the description covers selection semantics, mate types, limit behavior and even states what the result reports. What is missing is failure/precondition context, which matters for a mutation tool with no annotations.

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?

Schema coverage is already 85%, yet the description adds genuine meaning: the simple-vs-full form mapping, that minimum/maximum turn a distance mate into a LIMIT mate where 'value is where it starts', and the axis-vs-surface distance rule with a concrete example (radius 20, gap 0.5 → 20.5). That is value well beyond the schema.

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?

States a specific verb and resource ('Add a mate in the active assembly between two references') and immediately distinguishes two calling forms (simple point1/plane1 vs full ref1/ref2). An agent can tell exactly what this does and how it differs from the edit/delete mate siblings.

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?

Rich guidance on *how* to call it (which sibling tools supply ids, component paths for sub-assemblies), but no explicit statement of when to use this versus edit_mate, step_mate or suppress_mate, and no prerequisites (e.g., an active assembly must be open). Usage is implied rather than framed.

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