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
| Name | Required | Description | Default |
|---|---|---|---|
| flip | No | Put the distance / angle on the other side | |
| ref1 | No | What 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'. | |
| ref2 | No | What 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'. | |
| unit | No | Unit for points and distance (mm, cm, m, inch or ft) | |
| value | No | Distance for a distance mate, degrees for an angle mate | |
| plane1 | No | Instead of point1: Front, Top, Right or an assembly plane name | |
| plane2 | No | Instead of point2: Front, Top, Right or an assembly plane name | |
| point1 | No | ||
| point2 | No | ||
| maximum | No | With mate_type distance: largest distance allowed | |
| minimum | No | With mate_type distance: smallest distance allowed. Together with maximum this makes a LIMIT mate; value is where it starts. | |
| alignment | No | Whether the two faces point the same way (aligned) or against each other (anti_aligned) | closest |
| mate_type | Yes | Kind of mate |