Hole
holeDrills parametric bores from sketch circles on body faces, supporting depth/through, counterbore/countersink, threading, and wall-aware direction control.
Instructions
Drill a parametric Hole from a sketch (one or more circles) placed on a face of an existing body feature. Lengths mm.
depth_type: 'Dimension' (use depth) or 'ThroughAll'.
cut_type: 'None' | 'Counterbore' | 'Countersink' | 'Counterdrill'; when not
'None', cut_diameter (head clearance) and cut_depth apply.
threaded=True taps it. thread_type / thread_size are COUPLED enums ('M4' fits
'ISOMetricProfile', not 'UNC') — discover them with list_thread_options().
intended_for ('print'|'machine'|'drawing'): sets the ModelThread default when
threaded. print → modelled thread (a printed pilot won't self-tap);
machine/drawing → cosmetic thread (CAM/drawings read the metadata; modelled
threads bloat files and fight patterns/fillets). model_thread overrides it.
through ('wall'|'body'): preferred over depth_type. 'wall' ray-casts to the
first exit and drills exactly one wall — use it on shelled bodies, where
'body' (ThroughAll) destroys the cavity. Implies direction='into_body';
result carries wall_depth_mm.
direction ('into_body'|'away_from_body', preferred over the legacy raw
reversed, honoured only when neither is set; Hole and Pocket read it
differently): picks the Reversed value that does / does not remove material.
strict: raise instead of warn on a degenerate hole.
Returns {handle, name, volume, removed_volume, volume_ratio}, plus warnings
ONLY when the hole consumed the whole body or removed nothing (strict=True
makes those errors). direction='away_from_body' never warns.
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": {
"sketch": "<sketch>"
},
"name": "hole"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Hole | |
| depth | No | ||
| sketch | Yes | ||
| strict | No | ||
| through | No | ||
| cut_type | No | None | |
| diameter | No | ||
| reversed | No | ||
| threaded | No | ||
| cut_depth | No | ||
| direction | No | ||
| workspace | No | Run this call in this named workspace | |
| depth_type | No | ThroughAll | |
| thread_size | No | ||
| thread_type | No | ||
| cut_diameter | No | ||
| intended_for | No | ||
| model_thread | No |