Agent-first CAD: editable .kcad.ts source, deterministic review, OpenCASCADE kernel.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Use this when you need to add a mate connector to a part. Durably insert `<partBinding>.connector(name, { type, origin, axis?, normal? })` before the final top-level return. Use the part binding returned by add_part. Returns modified source plus diagnostics from re-evaluation. Side-effect-free.
The .kcad.ts source code.
Connector name unique within the part.
Origin as [x, y, z] shorthand, or a structured ConnectorOrigin.
JS identifier bound to an AssemblyPartRef, e.g. "basePart".
Optional [x, y, z] axis.
Optional [x, y, z] normal.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Use this when you need to add a mate connector to a part. Durably insert `<partBinding>.connector(name, { type, origin, axis?, normal? })` before the final top-level return. Use the part binding returned by add_part. Returns modified source plus diagnostics from re-evaluation. Side-effect-free.
| Argument | Type | Description |
|---|---|---|
| axis | array | Optional [x, y, z] axis. |
| code* | string | The .kcad.ts source code. |
| name* | string | Connector name unique within the part. |
| type* | string | |
| normal | array | Optional [x, y, z] normal. |
| origin* | any | Origin as [x, y, z] shorthand, or a structured ConnectorOrigin. |
| part_binding* | string | JS identifier bound to an AssemblyPartRef, e.g. "basePart". |
{
"type": "object",
"required": [
"code",
"part_binding",
"name",
"type",
"origin"
],
"properties": {
"axis": {
"type": "array",
"items": {
"type": "number"
},
"description": "Optional [x, y, z] axis."
},
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"name": {
"type": "string",
"description": "Connector name unique within the part."
},
"type": {
"enum": [
"frame",
"axis",
"planar",
"ball"
],
"type": "string"
},
"normal": {
"type": "array",
"items": {
"type": "number"
},
"description": "Optional [x, y, z] normal."
},
"origin": {
"oneOf": [
{
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "[x, y, z] shorthand."
},
{
"type": "object",
"required": [
"kind",
"value"
],
"properties": {
"kind": {
"enum": [
"vec3"
],
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"description": "Explicit numeric origin."
},
{
"type": "object",
"required": [
"kind",
"query"
],
"properties": {
"kind": {
"enum": [
"topology"
],
"type": "string"
},
"query": {
"type": "object",
"required": [
"kind",
"name"
],
"properties": {
"kind": {
"enum": [
"face-center",
"face-normal",
"vertex",
"edge-axis"
],
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"description": "Topology-derived origin."
}
],
"description": "Origin as [x, y, z] shorthand, or a structured ConnectorOrigin."
},
"part_binding": {
"type": "string",
"description": "JS identifier bound to an AssemblyPartRef, e.g. \"basePart\"."
}
}
}Use this when you need to add a sketch constraint to a list. Append one validated sketch constraint to a constraint list. Side-effect-free: pass { constraints, constraint } and receive the updated list.
| Argument | Type | Description |
|---|---|---|
| constraint* | object | The constraint to append. |
| constraints | array | Existing constraint list to append to (omit for an empty list). |
{
"type": "object",
"required": [
"constraint"
],
"properties": {
"constraint": {
"type": "object",
"required": [
"id",
"type",
"entities"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"COINCIDENT",
"DISTANCE",
"HORIZONTAL",
"VERTICAL",
"PARALLEL",
"PERPENDICULAR",
"EQUAL_LENGTH",
"TANGENT",
"RADIUS",
"ANGLE",
"CONCENTRIC",
"SYMMETRIC"
],
"type": "string"
},
"value": {
"type": "number",
"description": "Required for DISTANCE, RADIUS, and ANGLE."
},
"entities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ids of the entities the constraint relates."
}
},
"description": "The constraint to append."
},
"constraints": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"entities"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"COINCIDENT",
"DISTANCE",
"HORIZONTAL",
"VERTICAL",
"PARALLEL",
"PERPENDICULAR",
"EQUAL_LENGTH",
"TANGENT",
"RADIUS",
"ANGLE",
"CONCENTRIC",
"SYMMETRIC"
],
"type": "string"
},
"value": {
"type": "number"
},
"entities": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"description": "Existing constraint list to append to (omit for an empty list)."
}
}
}Use this when you need a freeform/organic 3D curve — a body feature line, brow, spine rail, or G2 blend between panels — authored as a Curve3D into the user's .kcad.ts immediately before the last top-level return. One authoring path, selected by `kind`: - 'nurbs' — insert a `nurbsCurve(controlPoints, opts?)` declaration. Pass `controlPoints` as a Vec3[] (mm, at least 2 points). Optional NURBS knobs: `degree` (default 3), rational `weights`, explicit `knots`, `closed`. - 'hermite' — insert a `hermiteG2(a, b)` declaration: a quintic Hermite curve interpolating two endpoints with matching positions, tangents, and (optional) curvatures — bridges two curves with G2 continuity. Each endpoint is `{ point: Vec3, tangent: Vec3, curvature?: Vec3 }` in mm; tangent magnitude ~ chord length; curvature defaults to [0,0,0] (G1-only). The returned binding has type Curve3D (peer to Shape / Surface) — consume it via `add_variable_sweep` (spine input), `add_surface({ kind: 'boundary' })` (boundary curve), or downstream Curve3D-accepting features. Returns the modified code + diagnostics from re-evaluating. Side-effect-free. Each kind fails closed on its own missing required params.
| Argument | Type | Description |
|---|---|---|
| a | object | kind:'hermite' — start endpoint. |
| b | object | kind:'hermite' — end endpoint. |
| code* | string | The .kcad.ts source code. |
| kind* | string | Which curve-construction path to use. |
| knots | array | kind:'nurbs' — optional explicit knot vector; missing => clamped-uniform inferred. |
Use this when you need to insert a new feature line into a script. Insert a new feature line into a kernelCAD script before the last top-level return statement. Returns the modified code as text plus diagnostics from re-evaluating the result. Side-effect-free. Primitives that accept faceLabels (box, cylinder, extrudeRect, extrudeCircle, extrudePolygon, extrudeRoundedRect) can receive `opts.faceLabels` in the inserted code — use `lookup_api` to see `featureKindFaceLabels` for the full value schema.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| feature_code* | string | Single-statement source line to insert (e.g. `const hole = cylinder(5, 2).translate(10, 10, -1);`). |
{
"type": "object",
"required": [
"code",
"feature_code"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"feature_code": {
"type": "string",
"description": "Single-statement source line to insert (e.g. `const hole = cylinder(5, 2).translate(10, 10, -1);`)."
}
}
}Use this when you need to author a mate-graph relationship into the source, selected by `relation` (default 'mate'): - 'mate' — a typed mate between two connectors ({ name, a, b, type, pose?, limitsDeg?, limitsMm? }). - 'coupling' — couple a driven mate to a source mate by ratio ({ driven, source, ratio, offset? }). - 'transmission' — a physical drive path across mates ({ name, kind, sourceMate, drivenMates, path, ... }). All durably edit source and need { code, assembly_binding }. Params other than `relation` are forwarded verbatim; each relation fails closed on its own missing required params.
| Argument | Type | Description |
|---|---|---|
| a | string | relation:'mate' — connector ref "<partName>.<connectorName>". |
| b | string | relation:'mate' — connector ref "<partName>.<connectorName>". |
| code* | string | The .kcad.ts source code. |
| kind | string | relation:'transmission' — transmission kind. |
| name | string | relation:'mate'|'transmission' — name unique within the assembly. |
| path | array | relation:'transmission' — drive path. |
| pose | object | relation:'mate' — optional mate pose. |
| type | string | relation:'mate' — mate type. |
Use this when you need to add a part to an assembly. Durably insert `const <binding> = <assembly>.part(partName, shapeExpression, opts?)` before the final top-level return in a kernelCAD source string. Returns modified source plus diagnostics from re-evaluating it. Side-effect-free: caller persists the returned source.
| Argument | Type | Description |
|---|---|---|
| at | array | Optional [x, y, z] assembly placement. |
| code* | string | The .kcad.ts source code. |
| part_name* | string | Assembly-unique part name. |
| binding_name | string | Optional JS const name for the returned AssemblyPartRef. Defaults to a part-name-derived identifier. |
| assembly_binding* | string | JS identifier bound to assembly(...), e.g. "arm". |
| shape_expression* | string | JS expression for the Shape to pass to assembly.part, inserted verbatim. |
{
"type": "object",
"required": [
"code",
"assembly_binding",
"part_name",
"shape_expression"
],
"properties": {
"at": {
"type": "array",
"items": {
"type": "number"
},
"description": "Optional [x, y, z] assembly placement."
},
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"part_name": {
"type": "string",
"description": "Assembly-unique part name."
},
"binding_name": {
"type": "string",
"description": "Optional JS const name for the returned AssemblyPartRef. Defaults to a part-name-derived identifier."
},
"assembly_binding": {
"type": "string",
"description": "JS identifier bound to assembly(...), e.g. \"arm\"."
},
"shape_expression": {
"type": "string",
"description": "JS expression for the Shape to pass to assembly.part, inserted verbatim."
}
}
}Use this when you need a freeform/organic 2D outline — an eyewear brow, ergonomic grip, sneaker midsole, or body silhouette — by appending a curved segment to an existing PathBuilder chain on the named `chain_anchor` variable. The call is injected at the END of the chain, immediately before any `.close()`. One segment kind, selected by `kind`: - 'spline' — `.spline(points, opts?)`: interpolates through every `points` waypoint (Vec2[] mm, >= 2 entries; points[0] must match current pen position). Optional `tension`, and `startTangent`/`endTangent` 2D direction vectors that constrain the first-derivative direction at the endpoints (magnitude normalised internally). Use for organic 2D outlines (eyewear brow, ergonomic handle, sneaker midsole). - 'nurbs' — `.nurbsSegment(controlPoints, opts?)`: explicit B-spline net (Vec2[] mm, >= degree+1 entries; controlPoints[0] must match pen; pen ends at controlPoints[N-1]). Optional `degree` (default 3), rational `weights` (strictly positive), explicit `knots` (length = controlPoints.length + degree + 1). - 'hermite' — `.hermiteG2(a, b)`: each endpoint `{ point: Vec2, tangent: Vec2, curvature?: Vec2 }` in mm (a.point must match pen; pen ends at b.point). `curvature` defaults to [0,0] (G1); pass matching curvatures for G2 blends. Tangent magnitude is the first derivative (~ chord length), NOT unit length. Returns the modified code + diagnostics from re-evaluating. Side-effect-free. Each kind fails closed on its own missing required params.
| Argument | Type | Description |
|---|---|---|
| a | object | kind:'hermite' — start endpoint; point must match current pen position within 1e-6 mm. |
| b | object | kind:'hermite' — end endpoint; pen ends at b.point. |
| code* | string | The .kcad.ts source code. |
| kind* |
Use this when you need to repeat a feature in a pattern. Insert a Shape.patternLinear / .patternCircular / .patternGrid call into a kernelCAD script before the last top-level return. Pass structured args (kind + the matching spec object). Returns the modified code plus diagnostics from re-evaluating. Side-effect-free. The pattern feature is a single editable unit; pattern-instance face refs resolve via `<sourceId>_pattern_<i>` on the pattern feature's lineage. Geometric note: pattern is implemented as cumulative boolean union of transformed source copies — additive features (boxes, ribs, fins, spokes) pattern cleanly; patterning a subtractive feature (hole, cutout) only preserves the per-instance void when adjacent bodies are disjoint.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| grid | object | Required when kind=grid. |
| kind* | string | |
| linear | object | Required when kind=linear. |
| target* | string | Variable name of the Shape to pattern (inserted verbatim as the LHS receiver). |
| circular | object | Required when kind=circular. |
| assign_to | string | Optional const-binding name; emits `const <assign_to> = <target>.patternX(...);`. Omit for statement form. |
Use this when you need an organic, freeform, or swept shape — a body shell, panel, fairing, ergonomic curve, lens, or sculpted form — authored as a NURBS Surface into the user's .kcad.ts, OR when you need to finish surfaces into a watertight solid or taper faces for moldability. One authoring/finishing path, selected by `kind`: - 'nurbs' — insert a nurbsSurface(...) / surfaceFromCurves(...) call. Pass either { controls, degree, weights?, knots?, periodic? } for direct construction, OR { section_sketch_ids } for skinning. Weights are honored: supply rational weights to build exact circles/cylinders/spheres/conics (the surface becomes rational); omit weights for a non-rational surface. - 'boundary' — insert a surfaceFromBoundary([c1,c2,c3,c4], opts?) call: one NURBS face through 4 boundary Curve3D refs (bottom, right, top, left in loop order; adjacent endpoints must coincide within 1e-6 mm). - 'trim' — insert a `<surface>.trimTo(<by>)` or `<surface>.split(<by>)` call. Pass `surface_binding` (the Surface variable name), `by_binding` (the cutter Surface variable name; Shape/Curve3D cutters are deferred to a later slice), and `op: 'trim'` (keep the largest imprinted piece) or `op: 'split'` (return both halves as a `[Surface, Surface]` tuple). - 'sew' — insert a `sew([s0, s1, ...], opts?)` call to stitch N surfaces into a closed watertight solid. Pass `surface_bindings` (array of Surface variable names). Use after trim/boundary to close patches into a solid: trim → sew → solid pipeline. Optional `tolerance` (mm, default 1e-6) and `require_closed` (emits feature.surface-sew.open-shell if result is not watertight). - 'draft' — insert a `<shape>.draft(angleDeg, { face, neutralPlane?, pullDir? })` call to taper the selected face(s) for mold release. Pass `shape_binding`, `angle_deg` (0–90), and `face` (canonical name, label, or FaceQuery descriptor). Lowering emits feature.draft.failed on invalid geometry. The returned Surface produces no Shape until you chain .thicken(t) or .toShape() (do that via add_feature on the binding name). Returns the modified code + diagnostics. Each kind fails closed on its own missing required params.
| Argument | Type | Description |
|---|---|---|
| op | string | kind:'trim' — 'trim' discards the smaller half (calls .trimTo()); 'split' retains both halves (calls .split()). |
Use this when you need to author text into a kernelCAD script before the last top-level return. One authoring path, selected by `mode`: - 'sketch' — insert a sketch.text(...) call. The emitted sketch is chainable: pair with subsequent .extrude(...) / cut(...) edits to land an engraved or raised text feature. - 'emboss' — insert a `<shape>.embossText({...})` chained call onto an existing Shape `target`. Use for engraved brand text on faces (Ray-Ban temple, CE mark, model number). `depth > 0` raises text out of the face; `depth < 0` engraves text into the face. Lowers via replicad drawText → sketchOnFace → extrude → fuse|cut. Default font is the runtime-bundled Liberation Sans. Side-effect-free; returns the modified code plus diagnostics from re-evaluating. Each mode fails closed on its own missing required params.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| face | string | mode:'emboss' — target face — canonical name ('top'/'bottom'/'left'/'right'/'front'/'back') or label. |
| font | string | mode:'sketch' — optional logical font name or .ttf file path; defaults to bundled Liberation Sans. |
| mode* | string | Which text-authoring path to use. |
| size | number | mode:'sketch'|'emboss' — glyph cap height in mm (positive finite). |
| align | string | mode:'sketch' — horizontal alignment relative to position (default left); mode:'emboss' — relative to the UV anchor (default center). |
Use this when you need an organic swept solid whose cross-section changes along its length — a tapering body, horn, bottle, handle, ring band, fairing, or duct — authored as a variable-section sweep along a spine. Inserts `variableSweep(spine, sections, opts?)` into the .kcad.ts `code` immediately before the last top-level return (an empty `code` starts a new script that returns the sweep). Spine: EITHER `spine_points` ([[x,y,z], ...] in mm, interpolated with spline3d; `spine_closed: true` closes the loop for a ring) OR `spine_binding` (an existing Curve3D / Sketch / Vec3[] variable). Each section: `t` in [0, 1] plus a profile — inline `radius` (circle) or `width` + `height` (rectangle), or `profile_binding` (an existing Sketch); profiles are centred on the spine and turned to face along it. Sections are strictly increasing in t, first t=0, last t=1 (omit t on every section to space them evenly). On a closed spine t=1 is the seam and reuses the t=0 profile. Example: { code, spine_points: [[0,0,0],[0,10,30],[0,0,60]], sections: [{ t: 0, radius: 8 }, { t: 0.5, radius: 10 }, { t: 1, radius: 4 }] }. Returns the modified code, diagnostics from re-evaluating it, and `sweep` { volumeMm3, bbox } measured from the built solid (ok:false when the sweep built nothing). The result is a Shape binding: return it, or chain `.union(...)` etc. via add_feature. Orientation is not exposed by this MCP tool until runtime orientation support is wired. Side-effect-free.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code ("" for a new script). |
| closed | boolean | Optional closed-sweep flag. |
| sections* | array | Varying cross-sections along the spine; at least 2 entries, strictly increasing in `t`, first t=0, last t=1. |
| continuity |
Use this when you need to declare a reachability target for a connector. Durably insert `<assembly>.workspace(connectorRef, { reachable, toleranceMm? })` before the final top-level return. Workspace targets are checked by solvedModel validation/review pose-envelope gates. Returns modified source plus diagnostics from re-evaluation.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| reachable* | array | World-frame Vec3 targets the connector must be able to reach. |
| toleranceMm | number | Optional non-negative tolerance in mm. |
| connector_ref* | string | Connector ref "<partName>.<connectorName>". |
| assembly_binding* | string | JS identifier bound to assembly(...). |
{
"type": "object",
"required": [
"code",
"assembly_binding",
"connector_ref",
"reachable"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"reachable": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"description": "World-frame Vec3 targets the connector must be able to reach."
},
"toleranceMm": {
"type": "number",
"description": "Optional non-negative tolerance in mm."
},
"connector_ref": {
"type": "string",
"description": "Connector ref \"<partName>.<connectorName>\"."
},
"assembly_binding": {
"type": "string",
"description": "JS identifier bound to assembly(...)."
}
}
}Use this when you need to author and evaluate a fillet or chamfer on a kernelCAD Shape. Inserts Shape.fillet(radius, selector, { continuity: G1|G2 }) or Shape.chamfer(distance, selector) through the existing public API and returns the patched source plus evaluation diagnostics. Selectors accept EdgeSelector syntax, including canonical edge refs/query strings or { face: canonical name, face label, or face query }. G2 continuity applies to fillets; chamfer uses the existing chamfer API. This authors the operation and does not extract blend-surface NURBS poles; that still requires kernel surface extraction.
| Argument | Type | Description |
|---|---|---|
| code* | string | Inline .kcad.ts source. |
| radius | number | Fillet radius in mm; required for operation:'fillet'. |
| distance | number | Chamfer distance in mm; required for operation:'chamfer'. |
| selector | any | Optional EdgeSelector: a canonical @kc[...] edge ref/query string or { face: canonical face name, face label, or FaceQuery descriptor }. Omit to select all sharp edges. |
| operation | string | Operation; defaults to 'fillet'. |
| continuity | string | Fillet continuity passed to the existing public API; defaults to G1. Chamfer ignores this field. |
| shape_binding* | string |
Use this when you need to render a script's animation timeline to a video, or a 360° turntable of a model for sharing. Capture a kernelCAD script's animationView({...}) timeline to an MP4 (ffmpeg) or a PNG frame sequence, verifying the sampled poses for part interference. FILE ONLY: pass { file } (a .kcad.ts path) — there is no { code } mode, because the capture engine renders from a file on disk (its relative lib.fromSTEP imports resolve against the script directory). MP4 by default; pass { frames_dir } to write frame-0000.png... and skip ffmpeg entirely (mutually exclusive with output_path). Animation-pose interference verification runs by default (keyframe times + segment midpoints) BEFORE any browser/ffmpeg cost; { no_verify: true } skips it and { verify_every: n } additionally samples every n-th frame time. Pass { focus } or { hide } (arrays of feature ids or assembly part names, mutually exclusive) to isolate parts in the rendered frames — same semantics as `kernelcad render --focus/--hide`; visibility is render-only and does NOT affect the pose verification. Collisions DO NOT fail the call — the artifact is still written as evidence with ok: true; read verified: false + the collisions[] array. TURNTABLE MODE: pass { turntable: true } for a seamless 360° orbit of the model (no animationView record needed) — a share-ready loop for a README, social post or product page. It uses the 'publish' studio look by default (same as render_preview preset: 'publish': key/fill/rim lights, soft contact shadow, clean backdrop, 30° lens, constant auto-framing over the whole orbit, light rig turns with the camera); { preset: 'default' } keeps the engineering look. Knobs: width/height (default 1080×1080, max 2048, even for MP4), duration_ms (one revolution, default 6000), fps (default 30), elevation_deg (default 22), background ('white' default, 'light', 'dark', 'black', '#rrggbb', or 'transparent' with frames_dir only), shadow (default true), environment. output_path ending in .gif writes a looping GIF; otherwise MP4. Frame i sits at az 30° + 360°·i/N (the 360° endpoint is excluded, so the loop is seamless). A turntable has no poses to verify: it reports verify_skipped: true. ENVIRONMENT: needs playwright chromium (npx playwright install chromium) and ffmpeg for MP4/GIF (frames_dir needs neither); the bundled static player is served automatically, no dev server required. Returns { ok, output_path, frame_count, duration_ms, fps, verified, verify_skipped?, collisions: [{ t_ms, a, b, volume_mm3 }], diagnostics }.
Use this when the goal is complex / production / enclosure / gearbox / robot-arm / multi-body, or when you need evaluate→review/verify→revise until green. PREFERRED over one-shot evaluate_script+open_in_studio for Adam-level parts. Runs a CAD design loop over attempt scripts: review_cad each attempt, continue past functional attempts with unresolved warnings, return repair prompts (nextActionPrompt) plus structured revisionAssist (suggestedPatches / autoApplied.suggestedCode for repairable feature failures; cookbook steers for stacked-primitive toys). Stop on ok or convergence.escalate. To pick among N alternative candidates for one goal without a judge, pass them all as attempts with consensus:true (geometric medoid selection). For organic/car bodies set likenessProfile:"automotive" and pass bodyLikeness (or automotive stills on visualReview.checks) — attempts fail closed until body-likeness is publishReady. Optionally write a Studio build record JSON.
| Argument | Type | Description |
|---|---|---|
| goal* | string | Original user design goal. Fed into every review_cad repair prompt. |
| assembly | string | |
| attempts* | array | Ordered design attempts. Each item is { id?, title?, file? OR code?, visualReview? } — provide file or code (at least one). File attempts can be replayed by Studio build records. |
| consensus | boolean | Best-of-N by geometric consensus. When true, attempts are N independent candidates for the SAME goal (not a repair sequence): all are reviewed (stopOnPass ignored), all scripts are executed, candidates without a valid solid are dropped, and the candidate whose geometry agrees most with the others (medoid by symmetric Chamfer distance, same model frame) is selected. Ties go to more gates passed, then the shorter script. Returns consensus { chosenIndex, chosenAttemptId, scores, distances, reason }; ok / finalAttemptId / nextActionPrompt describe the selected candidate. Default false. |
Use this when you need a manufacturability (DFM) report before printing or machining a part: returns a pass/fail checklist, no dfmSpec(...) needed. Pass { file | code } and optional processes (default ['fdm', 'cnc']). FDM 3D printing checks: fdm.overhangs (unsupported overhang steeper than max_overhang_deg, default 45° from vertical), fdm.bridging (bridges over max_bridge_mm, default 10), fdm.min-wall (walls under 2 × nozzle_mm, default 0.4 mm nozzle), fdm.min-hole (holes under 5 × nozzle), fdm.min-pin (warn), fdm.bed-fit (printer profile bed, default generic-fdm), fdm.bed-contact (warn). CNC 3-axis milling checks: cnc.undercuts (surface unreachable from approach_axes, default ['+z']; list several axes for several setups) and cnc.internal-corner-radius (sharp internal corners and fillets smaller than the end-mill radius, tool_diameter_mm default 6). Returns { ok, verdict: 'pass'|'fail', checks: [{ id, process, part, status: 'pass'|'fail'|'warn', summary, value?, limit? }], fdm?, cnc?, diagnostics }. Settings from the script's dfmSpec({ process: 'fdm' }) are used as defaults; call options win. For the script-declared gates (clearance, voids, channels) use verify({ check: 'dfm' }).
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| printer | string | FDM printer profile id for the bed-fit check. Default 'generic-fdm'. |
| nozzle_mm | number | FDM nozzle diameter, mm. Default 0.4. |
Use this when you need to know WHAT MATERIAL changed between two versions of a model, not just how much. The deeper sibling of diff_scripts: a volume delta alone is ambiguous (a boss that grew and a pocket that deepened report the same magnitude, and a part that only moved reports zero), so this tool answers it with geometry instead of pixels. Baseline is { baseFile } or { baseCode }; the revised side is either another script ({ file } or { code }) or the SAME script re-lowered with { params } overrides — a bag of declared param() name -> new value, which is the one-script form a parameter sweep actually asks for. Bodies pair by name and fall back to declaration-order positional pairing; anything left over is listed in `unmatched` and raises diff.body.unmatched. Per matched body it returns addedMm3 = volume(revised - base), removedMm3 = volume(base - revised), commonMm3 = volume of the overlap from boolean intersection, exact bbox with min/max/extent deltas, face / edge / hole count deltas (hole counts reuse the cylindrical-hole detector), maxDeviationMm (two-sided discrete Hausdorff distance between the two surfaces), and a `verdict` — identical | moved | resized | topology-changed, precedence topology-changed > resized > moved > identical. Branch on the verdict; cite the numbers. Optional { render: true } also writes an overlay PNG (added green, removed red, unchanged material as a translucent ghost; the scene is a re-runnable .kcad.ts over lossless BREP sidecars) through the render_preview pipeline and fails open (the numeric diff is still returned) when that pipeline is unavailable. Read-only — never touches the active session.
| Argument | Type | Description |
|---|---|---|
| code | string | Revised script — inline source. Mutually exclusive with params. |
| file | string | Revised script — path to a .kcad.ts file. Mutually exclusive with params. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
Use this when you need to see exactly what changed between two script versions. Structured geometric delta between two versions of a kernelCAD script — a baseline ({ baseFile } or { baseCode }) and a revision ({ file } or { code }). Returns agent-readable JSON: per-part added/removed/renamed/changed (volume mm³ + exact bbox deltas, numbers matching inspect({ of: 'part-stats' })), total interference-volume delta with per-pair detail, mate-graph changes (added/removed/changed mates incl. type, connectors, pose, limits), and param changes (value/min/max). Single-shape scripts diff as one "(root)" pseudo-part; a `return [a, b]` multi-body script diffs per body as "body[0]", "body[1]". An error that still leaves geometry (e.g. a skipped fillet) is listed under base/revised.errors beside the diff. Use after editing a script to verify exactly what changed physically before re-rendering. On a hosted server pass both versions inline: { baseCode: 'return box(10, 10, 10);', code: 'return box(10, 10, 12);' } (base_code/old_code/before and revised_code/new_code/after are accepted as aliases). Read-only — never touches the active session.
| Argument | Type | Description |
|---|---|---|
| code | string | Revised (after) script — inline source. One of file / code is required. |
| file | string | Revised (after) script — path to a .kcad.ts file. Local servers only. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| baseCode | string | Baseline (before) script — inline source. One of baseFile / baseCode is required. |
| baseFile | string | Baseline (before) script — path to a .kcad.ts file. Local servers only. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
Use this when the reference for a part is a 2D engineering drawing PDF (orthographic views with dimensions), not a photo. Deterministic, no vision model: reads the vector linework (stroke width, dash) and positioned text; classifies visible / hidden / center / dimension / extension lines; reads the title block scale, units and projection symbol; identifies front / top / side views by projection alignment (third- or first-angle); ties dimension text to its lines (⌀, R, 4×, ±, THRU, depth). Dimension values win over measured lengths. Rebuilds the part as the view silhouette extruded by the depth an orthogonal view shows, or a turned part revolved from its half-silhouette, plus holes from ⌀ circles with THRU or hidden-line depth. Returns `script` — a `.kcad.ts` with role-named params (width, thickness, holeDia, hole1X, dia1, step1Length …) — and `ledger`, an assumption ledger where stated dimensions are `visible`, symmetry-derived positions `inferred`, defaults `assumed` and an unstated depth `missing`; a dimension that disagrees with the linework keeps its value and records the disagreement as an open fact. With verify (default) the script is evaluated, re-projected through the svg-drawing view stage and compared: `fidelity.verdict` is match | partial | mismatch | failed with per-axis extents, hole diameters and per-view silhouette IoU. Pass `out` to write the script and its `<stem>.ledger.json` (resolve open facts with resolve_assumptions, then set_param). A scanned (raster-only) page fails with reference.drawing.raster-only — use trace_from_image for those. Hosted: give the file as an https:// URL, a data: URI (base64, max 25 MB) or "asset:<id>" from request_upload (when the file is on the user's device).
| Argument | Type | Description |
|---|---|---|
| out | string | Write the emitted script here (a .kcad.ts path); the ledger is written beside it as <stem>.ledger.json. |
| page | integer | 1-based page to read. Default 1. |
| path | string |
Use this when you need to run a script and check it compiles. Full local builds return viewerUrl: a live Studio link reused and updated on later full builds in the same MCP process. Hosted builds return viewerMode: hosted and viewerHint pointing to open_in_studio; they do not start a loopback viewer. Full evaluations return step evidence: build validity, volume and before/after local PNG paths in one shared iso frame. Snapshots require PW_CDP_URL for an existing browser; unavailable captures report an explicit error. Run a kernelCAD .kcad.ts script and report pass/fail + feature count + diagnostics + sceneSummary (BREP validity, volume in mm³, face count, bounding size in mm). When the scene is assembly-built (assembly().part(...) → .model()/.solvedModel()), also returns a parts summary { count, names } AND runs the mechanism-truth gate by default: the `mechanism` field reports real/broken/unverified and a broken mechanism (disconnected components / mechanism.orphan-part, self-collision, fastened drift, dof-mismatch) makes ok:false with the failures in diagnostics, as does a mate connector more than 6 mm outside its part bounding box (assembly.mechanical.connector-not-in-solid, the same error review_cad reports) — a mechanism (any mate or joint) needs every part linked by connectors + mates/joints (axis+revolute for shafts/hinges/gears; frame+fastened for rigid; or arm.revolute/.prismatic/.ball/.fixed). A plain multi-part assembly with no mates (base + lid, print layout) is independent bodies and passes. Pass { skipMechanismCheck: true } to opt out (e.g. a deliberately free part next to a mechanism). An animation or drive on a fastened joint (mechanism.motion-on-fixed-joint) is broken: animate a revolute/prismatic mate pose. For a model with moving joints or motion intent, `mechanismSummary.statement` is one plain line: "Motion checked: ..." names what ran; "Motion not checked: ..." is NOT a pass — never call that mechanism working. Every union() is checked too (no opt-out): union.disconnected (the union is several separate solids — a floating operand) and union.member-overlap (two operands that each carry their own .finish()/.material(), the same one, share > 1 mm³ — cut members to fit, e.g. a cross tube between rails is span minus two rail widths) make ok:false. Pass either { file: "<path>" } or { code: "<inline source>" }. Set { dryRun: true } for fast validation while iterating: transpile + capture + capture-light checks without building solids, DFM gates, or meshing — milliseconds instead of seconds (100x+ on boolean/fillet-heavy scripts). A dry run catches script throws, capture-time API misuse, and assembly validity-gate failures, but NOT lowering failures or dfmSpec diagnostics; it leaves the active session untouched, so finish with a full (non-dry) evaluate_script before using session-dependent tools. To show a measurement in the 3D viewer (e.g. hole spacing), declare it in the script with shape.dimension({ kind: "linear", from, to, label }); a full evaluate lists them as dimensions: [{ text, kind, source }], and a shared /p link with ?dims=1 forces them on. Hosted: lib.fromSTEP / fromSTL / fromDXF / fromSVG and referenceImage take a direct string literal or a const bound to one (computed expressions are unsupported). They accept "asset:<id>" (from request_upload), an https:// URL or a data: URI as the path.
Use this when you need to sample a signed-distance field at a point. Sample the signed distance from an in-script sdf.* field at a 3D point. Returns { distance, inside, aabb, kind }. Distance is in mm; negative = inside the surface, 0 = exactly on the surface, positive = outside. Use this to verify SDF composition before calling sdf.materialize (which is the expensive step). The script must bind the SdfField via sdf.bind('<name>', field) and pass that name as fieldName. Hint: pass either { file } or { code }, plus { fieldName, point: [x,y,z] }.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| point* | array | Sample point [x, y, z] in mm. |
| fieldName* | string | sdf.bind binding name holding the SdfField. |
{
"type": "object",
"required": [
"fieldName",
"point"
],
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"point": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Sample point [x, y, z] in mm."
},
"fieldName": {
"type": "string",
"description": "sdf.bind binding name holding the SdfField."
}
}
}Use this when you need evaluate_script (and optionally open_in_studio) for an industry / cookbook demo in ONE step — after lookup_cookbook for industry demos, prefer execute_cookbook when you need evaluate+Studio together; empty lookup is not a stop (freehand-author instead). Resolves a cookbook snippet by `id` or BM25 `query` (same ranking as lookup_cookbook), evaluates its body via evaluate_script with bounded vendor timeouts, and returns explicit status with stage resolve|evaluate|open_in_studio. Pass openInStudio:true to publish the same script via open_in_studio after a green full evaluate (hosted MCP). dryRun:true is the fast capture-only path — it is NOT evidence the cookbook builds a solid or is safe to publish; finish with dryRun:false (default) before claiming success or opening Studio.
| Argument | Type | Description |
|---|---|---|
| id | string | Cookbook snippet id (e.g. gt2-timing-belt-drive, extrude-rounded-rect-plate). |
| query | string | When id is omitted: natural-language query; BM25 picks the top hit (same as lookup_cookbook). |
| dryRun | boolean | Default false. dryRun:true is NOT evidence the cookbook builds a solid — capture-only checks; do not claim success or open Studio from a dry run alone. |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| kernel | string | Solid-modeling kernel forwarded to evaluate_script. Default 'occt'; opt-in 'smlib' uses guarded candidates with explicit OCCT fallback diagnostics. |
Use this when you need an ordered exploded-view plan for an assembly. Supply parts as {name,center:[x,y,z],size:[x,y,z]} in mm, or a LabWired handoff containing parts with ref, position_mm.value and physical.bbox_mm (also accepts bbox_mm.value). Optional explicit assembly_order takes precedence over handoff assembly_order / assembly.order. Missing order falls back to input part order; parts lacking usable placement or bbox and unlisted/unknown order refs are reported. Choose mode axis (default) or radial; axis follows the requested direction, radial moves parts away from the assembly centroid. The result includes ready-to-paste param_declarations, animation_tracks and reverse_animation_tracks for animationView(), part_transforms for existing shapes, and script_fragment. cameraPlan gives framing guidance.
| Argument | Type | Description |
|---|---|---|
| axis | array | Assembly direction; default +Z. |
| mode | string | Explode direction strategy; default axis. |
| parts | array | Named assembly parts and measured bbox centers/sizes in mm. Optional when handoff is supplied. |
| handoff | object | Optional handoff metadata. Assembly order lookup supports assembly_order or assembly.order. |
| spacing | number | Positive spacing scale; default 1.25. |
| duration_ms | integer | Timeline duration from 500 to 60000 ms; default 3000. |
Use this when you need to export geometry to a file. One exporter, selected by `target`: - target:'model' — export the script geometry to one file. Pass { file | code }, a required { output_path }, and { format }. Supported formats: stl (binary STL mesh), step (BREP CAD interchange), dxf (2D cut file for laser / waterjet / CNC: a flat part — plate, panel, extruded profile, in any orientation — exports its outline and holes in its own plane with exact arcs and circles; a sheet-metal part or a returned Region exports its flat pattern; a flat or sheet-metal part also returns sheet { thickness_mm, bend_count }, which a shop needs and the DXF does not carry; options.section { axis: "x"|"y"|"z", at } exports the cross-section of any part in world coordinates (plans, profiles); a multi-part model (cut list) writes all parts side by side on output_path, one layer per part, plus parts/<part>.dxf per part (reported in part_files; options.layout 'sheet' writes the combined sheet only); any other part fails with export.dxf.non-planar), 3mf (slicer-friendly mesh: one named object per part, colours as core-spec basematerials named by the part's engineering material; options.arrange 'plate' packs parts on the bed at Z=0 without overlap (options.orient puts each part's largest flat face down), 'assembled' keeps them together as one multi-part object for multi-colour prints; options.slicer 'bambu' | 'orca' | 'prusa' adds that slicer's per-object name + filament-slot sidecar — slot N is the Nth distinct colour/material), options.infill { fromFea: '<study>' | true, bands?, pattern? } = stress-graded FDM infill (requires the local CalculiX + gmsh toolchain; without it the export fails with fea.solver.unavailable): solves the feaStudy and writes modifier volumes, each with its own infill density (Orca/Bambu format by default; options.slicer 'prusa' writes PrusaSlicer's format instead, since the two are not interchangeable); the result carries infill { bands, saving, images }), gcode (installed OrcaSlicer output; preserves G-code and returns optional gcode_stats with header generator identity and slicer-predicted time/material), glb (web-viewer / AR with PBR materials), obj (Wavefront indexed triangle mesh), usd (ASCII USDA triangle mesh in millimeter, Z-up coordinates; multi-part scenes emit one named mesh per part), svg-drawing (third-angle engineering-drawing sheet: front/top/left + isometric views, hidden edges dashed, tangent edges thin, overall bounding-box dimensions, title block; assemblies are drawn with inter-part occlusion; pass options.annotations to dimension specific features instead of the bounding box; pass options.exploded { factor, mode } to explode the isometric cell, options.balloons to number parts from the BOM, and options.partsList for an item/name/qty/material table above the title block). overall bounding-box dimensions, title block; assemblies are drawn with inter-part occlusion; pass options.annotations to dimension specific features instead of the bounding box, options.autoAnnotate to derive datums A/B/C, grouped hole callouts with position tolerances, hole positions, overall size, radius and chamfer callouts, flatness and an ISO 2768 note from the geometry (the result carries drawing_report with placed / overlapped counts), and options.sections for real section views on any cutting plane). pdf-drawing (the same sheet — views, dashed hidden lines, dimensions, hole callouts, GD&T, sections, parts list — as a printable vector PDF on a standard sheet, one call: ISO a4|a3|a2|a1|a0 or ANSI ansi-a…ansi-e landscape, default a3, or sheet "auto" / "auto-ansi" for the smallest sheet that holds the views at 1:1; the drawing scale is picked to fit; projection "third" (default) or "first" arranges the views and draws the matching symbol; a full title block carries title, part name, material, scale, units, sheet size, date and revision, settable through options.title / partName / material / revision / date; autoAnnotate is on unless options.annotations is given). Robot descriptions: urdf (tree-topology robot description), srdf (motion-planning semantics layered over the URDF), sdf-gazebo (SDFormat 1.10 with native ball joints, closed loops, and solved per-link poses), usd-isaac (ASCII USD physics stage: PhysicsArticulationRootAPI root, one rigid body per link at its solved pose with mass / centre of mass / principal inertia, PhysicsFixedJoint/PhysicsRevoluteJoint/PhysicsPrismaticJoint per mate with token axis, two-sided joint frames and limits, UsdPreviewSurface materials from the part appearance, and joint drives only when declared in options.drives { <mate>: { stiffness, damping, maxForce?, targetPosition? } }; options.collisionApproximation is convexHull | convexDecomposition; planar/cylindrical/pin_slot/ball mates fail closed with export.usd.joint-unsupported). bom-csv / bom-json (bill of materials over assembly.model()/solvedModel(): one row per distinct part — grouped by geometry/catalog identity, not name — with real instance quantity, kind, material, density, mass, bbox, fabrication process (`process` + `processSource`), and catalog provenance for purchased parts; same numbers as inspect({ of: 'bom' })). order-pack (a zip: one single-body file per fabricated part — STEP always, plus STL for 3d-print and DXF for sheet-cut rows, per-part drawing PDFs where available — with bom.csv/bom.json, vendor paste handoff texts for purchased rows and a machine-readable manifest; options processes / items narrow which rows are packed; nothing is uploaded). bend-table (tube bender tables over tube() records: one <tube name>.csv per tube with the LRA bend table, XYZ points, cut length and last straight; output_path is a DIRECTORY and the written files are reported in table_files; a script with no tube() fails with export.bend-table.no-tubes, and a script whose tube gates report errors writes nothing). urdf and sdf-gazebo also write one meshes/<part>.stl per link, and usd-isaac one meshes/<part>.usda mesh layer per link, next to output_path (reported in mesh_files) — ship the whole directory to the consumer. STL exports run a watertight verify by default; failures return ok: false with export.mesh.not-watertight (open-edge count + up to 5 crack-cluster locations) but the file is still written so the broken mesh can be inspected. Optional { feature_id } selects which feature to export (default: last). Optional { options } carries per-format options bag (see the kernelcad-mcp skill for the per-format keys: dxf layers/tolerance/unit/section/layout, 3mf printUnit/embedSource/arrange/orient/slicer/printer/infill, glb axis/draco). - target:'part' — export solved-assembly parts as individual binary STL files in their modeled (world-frame) positions. Pass { file | code }, plus { part, output_path } for one part or { output_dir } for all parts (files land at <output_dir>/<part>.stl). A watertight verify runs on every exported mesh by default and fails the call with export.mesh.not-watertight; unknown part names fail with export.part.not-found listing the valid names. Pass { no_verify: true } to skip the watertight gate. All params except `target` are forwarded verbatim; each target fails closed on its own missing required params. Hosted server: the file is written on the kernelCAD server, NOT on the caller's machine. The result carries `downloads[]` — an HTTPS `url` per file (expires after 24 h; give it to the user) — Small text files an agent can read (SVG, DXF, URDF, JSON, CSV; up to 32 KB) also come inline as an embedded resource; STEP, STL, 3MF and GLB are link-only — do not fetch them into your context, give the user the link. `output_path` only names the file; the returned `output_path` is a server-side path, usable only as `file` in later calls to this server. HEAVY FORMATS (step/stl/3mf/glb): if OCCT serialization outlives the client tool-call limit, this tool returns { ok:true, status:"running", code:"export.deferred", job_id } while the export continues on the server — poll by calling export({ job_id }) until status is done/failed. CRITICAL: open_in_studio / paint does NOT need STEP. On export.deferred or any STEP stall, call open_in_studio immediately for the shaded widget; do not block paint on export.
Use this when the user wants to get a part made: packages the fabrication files into one directory plus a zip, and returns links to public instant-quote pages. Pass { file | code } and output_dir; optional scope ('part', default — one script's files; 'bom' — the whole assembly's BOM: per-part single-body files, per-part drawings, bom.csv/json and vendor handoff texts), name (default 'part'), formats (default step, stl, 3mf, pdf-drawing, bom-csv; add 'dxf' for flat or sheet parts), and processes ('3d-print' | 'cnc' | 'sheet-cut') to filter the links (bom: also narrows which fabricated rows are packed). Each file is written by the export tool, so its gates apply; a format that fails is reported in files[] and the rest still ship. Also writes manifest.json and README.txt. quote_links lists JLC3DP, JLCCNC, PCBWay, Xometry, SendCutSend and Craftcloud with the pack file to upload to each. One body per file: multi-body files are rejected by every shop. DXF is written only for flat or sheet-metal parts. The McMaster handoff text carries part numbers only, because McMaster quantities are packs and pack sizes are not in the catalog yet. These are plain web pages: nothing is uploaded or ordered. The user opens the link and uploads the file. Run dfm_review first if you have not. Hosted server: pack files are written on the kernelCAD server and returned in downloads[].url; nothing is uploaded to a fabrication service.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| name | string | Base file name (letters, digits, '.', '_', '-'). Default 'part'. |
| scope | string | Default 'part' (a single-part pack). 'bom' packs the whole assembly's BOM: per-part single-body files, per-part drawings, bom.csv/json, vendor handoff texts, and per-process quote links. |
Use this when you need a structural check's context without paying for a solve. Read-only: returns the stored summary of a previous run_fea (pass the same `output_dir`), whether the CalculiX + gmsh toolchain is available on this machine (with the install command when it is not; run_fea then uses its in-process voxel solver — toolchain.default_solver says which), and the FEA material table with real E / Poisson / yield numbers so a grade is chosen against data rather than from memory. Never meshes, solves, or writes.
| Argument | Type | Description |
|---|---|---|
| output_dir | string | Directory a previous run_fea wrote to; omit for toolchain status + material table only. |
{
"type": "object",
"properties": {
"output_dir": {
"type": "string",
"description": "Directory a previous run_fea wrote to; omit for toolchain status + material table only."
}
}
}Fetch one bundled catalog part. Prefer `await lib.standard.nema17()` and `await lib.standard.bearing608()` — they are offline and do not download remote STEP. A lookup that cannot finish fails within 45s with errorCode parts.lookup.timeout. Do not retry in parallel.
| Argument | Type | Description |
|---|---|---|
| id | string | |
| query | string | |
| family | string | |
| category | string | |
| standard | string | |
| partsBaseUrl | string | Opt-in remote endpoint; no default value ships with kernelCAD. |
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"query": {
"type": "string"
},
"family": {
"type": "string"
},
"category": {
"type": "string"
},
"standard": {
"type": "string"
},
"partsBaseUrl": {
"type": "string",
"description": "Opt-in remote endpoint; no default value ships with kernelCAD."
}
}
}Use this when a LabWired handoff part needs a STEP or GLB model resolved from a verified HTTPS URL plus SHA-256, or from catalog_id / MPN. The tool uses fetch_part/find_part catalog plumbing, stores URL-fetched bytes in a SHA-256 cache, checks the supplied hash, compares measurable model dimensions with bbox_mm, and returns provenance or a model_not_found result. GLB bounds are checked when POSITION accessor bounds are available; otherwise bbox_check.status is not_checked.
| Argument | Type | Description |
|---|---|---|
| mpn | string | |
| ref | string | |
| url | string | Direct public HTTPS download URL from the handoff step field. |
| source | string | Catalog or manufacturer name, such as KiCad Packages3D. |
| bbox_mm | array | Expected [x,y,z] dimensions from the handoff. |
| license | string | License string supplied by the source. |
| catalog_id | string | |
| attribution | string | |
| partsBaseUrl |
Search the bundled parts catalog (offline). For a NEMA-17 motor write `await lib.standard.nema17()`; for a 608 bearing write `await lib.standard.bearing608()`. Do not fan out parallel lookups and do not pass partsBaseUrl unless you set source:"remote". Remote lookups fail within 45s with errorCode parts.lookup.timeout instead of hanging.
| Argument | Type | Description |
|---|---|---|
| tag | string | |
| limit | number | |
| query | string | |
| family | string | |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| source | string | |
| category | string | |
| standard | string | |
| partsBaseUrl | string | Opt-in remote endpoint; no default value ships with kernelCAD. |
Use this when you need to fit an orthogonal least-squares plane to XYZ point-cloud data. Returns centroid, deterministic unit normal, signed point residuals, RMS residual and maximum absolute residual. Accepts points already parsed by the caller from scan data or mesh vertices. Computes parameters only; it does not create a surface body. Requires at least three non-collinear finite points.
| Argument | Type | Description |
|---|---|---|
| points* | array | Point cloud as [x, y, z] coordinate triples in model units. |
{
"type": "object",
"required": [
"points"
],
"properties": {
"points": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"maxItems": 100000,
"minItems": 3,
"description": "Point cloud as [x, y, z] coordinate triples in model units."
}
}
}Use this when you need the unfolded flat pattern of a bent sheet-metal part. Return the unfolded 2D flat-pattern of a bent sheet-metal Shape as a Region (outer polyline + holes + bend lines + sketch plane). Any number of parallel bends; crossing bends need corner relief. Pass { file } or { code }; optional { featureId } to pick a specific Shape.
| Argument | Type | Description |
|---|---|---|
| code | string | |
| file | string | Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| featureId | string |
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"file": {
"type": "string",
"description": "Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"featureId": {
"type": "string"
}
}
}Render a project's current model server-side and return it as an inline image so you can SEE what you built. Prefer open_in_studio for the happy path — it already includes an iso PNG preview in the same publish result when previewDelivered is true. Use this tool for a different `view`, a contact sheet (`view:"all"`), or when you only have a slug and are not publishing. Call with that `slug` to inspect whether the build looks right. CRITICAL — the image is rendered from the MODEL on the server; it does NOT reflect the user's Studio camera, zoom, or screen. NEVER ask the user to rotate, zoom, pan, move the camera, close a slider, or change their view to help you see — you cannot affect their screen and it cannot affect this render. To see a different angle, call this tool again with a different `view`. By DEFAULT (omit `view`, or `view:"all"`) it returns a CONTACT SHEET of all six canonical views in one labeled image — a 3×2 grid, top row [iso, front, right], bottom row [back, left, top] — so you can judge the model from every side regardless of its orientation (e.g. to find which side has the doors). Pass a single `view` (iso/front/back/left/right/top) for one large render of that angle. DETERMINISTIC: the same model + view always returns the same bytes — identical bytes are NOT a stale/lagging snapshot. If you changed the model, push it with open_in_studio FIRST, then re-render to see the change. The image is always current and never a blank capture. Colors and shading match Studio (same palette / base-material color). The slug is the capability: no OAuth for public/unlisted; private projects require the owner signed in. The PNG is base64-inlined as a real image block by default; pass `paths_only: true` for metadata only. No renderable geometry or a mesh failure → { ok: false, error, hint }, never a blank image. error "mesh_timeout" means the model took too long to build for a preview; the source is not wrong (it still exports) — do not rewrite it to fix the render.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Project slug from open_in_studio/get_project/a /p/<slug> link. The slug is the capability — public/unlisted projects need no OAuth; private projects require the owner to be signed in. |
Return the raw per-feature triangle mesh (positions/indices/normals) of a project's current model, by slug. For the in-chat 3D viewer widget to render geometry; delivered over the MCP Apps bridge. The slug is the capability: public/unlisted need no OAuth; private requires the owner signed in.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Project slug from open_in_studio/get_project. |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"description": "Project slug from open_in_studio/get_project."
}
},
"additionalProperties": false
}Use this when you need to reopen a saved project or browse what the user has saved — it fetches a kernelCAD Studio project, or lists the signed-in user's saved projects. Pass `slug` (from a /p/<slug> link or a prior listing) to fetch that project's full .kcad source and metadata — then edit and open_in_studio with the same slug so the user's open tab updates live. Private projects require their owner's OAuth connection. OMIT `slug` to list the signed-in user's saved projects (most recently updated first); that listing mode requires the OAuth connection and does NOT paint — prefer list_my_projects to find a project to continue. Read-only: this tool never shows a viewer (only open_in_studio does, once per response). Paint phases: projectSaved/meshReady reflect fetch state; viewerPainted stays false. Use open_in_studio (with code) to publish+paint — do NOT call get_model_mesh or get_latest_render for interactive paint.
| Argument | Type | Description |
|---|---|---|
| slug | string | The project slug from a listing or a /p/<slug> Studio link. Omit to list the signed-in user's saved projects. |
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"description": "The project slug from a listing or a /p/<slug> Studio link. Omit to list the signed-in user's saved projects."
}
},
"additionalProperties": false
}Fetch the exact immutable .kcad source and parameters captured at a prior `open_in_studio` version. Use this to read-after-write verify a release: pass the returned `slug` and `version`, then hash or inspect the returned source. Public/unlisted projects use the slug as capability; private projects require the owner's OAuth connection.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Project slug returned by open_in_studio. |
| version* | integer | Positive immutable revision version returned by open_in_studio. |
{
"type": "object",
"required": [
"slug",
"version"
],
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"description": "Project slug returned by open_in_studio."
},
"version": {
"type": "integer",
"minimum": 1,
"description": "Positive immutable revision version returned by open_in_studio."
}
},
"additionalProperties": false
}Use this when you need to read the human/agent selection in a local Studio session. Returns one clicked face or edge (or null), with current-generation mesh-local shapeIndex/kind/id and creating featureId. During a rebuild selection is null with “selection pending rebuild” until Studio uniquely verifies the face; ambiguous or deleted faces are cleared. Inspect the current shape before authoring a fillet. Requires a running local Studio opened on the same script; hosted sessions are not supported.
| Argument | Type | Description |
|---|---|---|
| session* | string | Studio sessionToken from GET /__kernelcad/session?script=<path>. Use the same script as the viewer. |
| studio_url* | string | Local Studio HTTP origin, e.g. http://localhost:5173. |
{
"type": "object",
"required": [
"studio_url",
"session"
],
"properties": {
"session": {
"type": "string",
"description": "Studio sessionToken from GET /__kernelcad/session?script=<path>. Use the same script as the viewer."
},
"studio_url": {
"type": "string",
"description": "Local Studio HTTP origin, e.g. http://localhost:5173."
}
}
}Use this when you need to place parts from a LabWired handoff.json into a KernelCAD assembly. Pass the parsed handoff object using schema labwired-kernelcad-handoff/0.1. The tool validates the handoff and returns an evaluable assembly script with corner-anchored bbox placeholder solids, origin/bbox-face/mounting-hole/pin anchors, endpoint connectivity mates for wires whose two endpoint positions are known, and structured cutout_hints from connector faces. These mates express connectivity intent only; no wire geometry or routing is generated. It does not cut enclosure walls or fetch STEP/GLB assets. position_mm locates the bbox lower corner; bbox.center is derived. Null, estimated, proposed, and other non-exact geometry is reported as warnings and omitted or placed at zero as appropriate.
| Argument | Type | Description |
|---|---|---|
| handoff* | object | Parsed handoff.json object using labwired-kernelcad-handoff/0.1. |
{
"type": "object",
"required": [
"handoff"
],
"properties": {
"handoff": {
"type": "object",
"description": "Parsed handoff.json object using labwired-kernelcad-handoff/0.1."
}
}
}Use this when the user wants to start from their own STEP or STL file (a part they designed elsewhere, a vendor model). Give exactly one source: url (a public https direct-download link), upload (a file the user attached in ChatGPT), or content_base64 (raw bytes, small files only). Max 50 MB. The format is detected from the bytes (or pass format: 'step' | 'stl'). Writes the file and a starter <name>.kcad.ts whose base body is lib.fromSTEP / lib.fromSTL into output_dir (default: a fresh temp dir), evaluates it, and returns { ok, format, model_path, script_path, code, bbox }. Pass script_path as { file } to evaluate_script, add_feature, dfm_review, export and the other tools, or edit code to build on the body. STL is a mesh: booleans, bbox and export work, but faces stay planar facets (use mesh_to_features for an editable feature tree). A non-watertight STL is refused unless allow_open is true.
| Argument | Type | Description |
|---|---|---|
| url | string | Public https URL that downloads the .step/.stp/.stl file directly. |
| name | string | Base name for the written files. Default 'imported'. |
| format | string | Override format detection. |
| upload | object | ChatGPT file reference for a file the user attached. |
| file_name | string | Original file name, used for format detection. |
| allow_open | boolean | STL only: accept a non-watertight mesh as an open shell. |
| output_dir |
Use this when you need to read facts about a model. One reader, selected by `of`: - 'assembly' — physical assembly inventory (parts, bboxes, connectors, mates, disconnected solids). - 'robot' — URDF/SDFormat export preview (links, joints, planning groups, end-effectors, issues). - 'step' — inspect an imported STEP file: solid tree, exact bbox/volume, cylindrical holes (breached bores flagged partial; holeDetection: 'exact' | 'heuristic'). - 'shape' — volume / surfaceArea / bbox for one feature ({ feature_id? }). - 'mass' — mass, centre of mass, centroidal inertia tensor (inertia6 + 3x3 inertiaMatrix), principalMoments/principalAxes, symmetry flags, and optionally the radius of gyration about an arbitrary axis ({ feature_id?, density?, gyration_axis? }); density in kg/m^3, defaults to 1000 (water). - 'features' — features captured by the script (kind, id, params, transforms, suppression). - 'assemblies' — assembly intent (assemblies, parts, connectors, joints). - 'topology' — canonical face names + edge count for a feature ({ feature_id? }). - 'edges' — edges of a shape with optional EdgeQuery ({ feature_id?, query? }); returns @kc[...] refs. - 'face-edges' — boundary edges of a named canonical face ({ feature_id?, face_name }). - 'faces' — faces of a shape with optional FaceQuery ({ feature_id?, query? }); returns @kc[...] refs. - 'face-labels' — user-applied labels visible in the script. - 'mates' — mates captured by the script. - 'constraints' — sketch constraints captured by the script. - 'part-stats' — bundled parts-catalog statistics. - 'bend-table' — sheet-metal bend table for a flattened pattern. - 'params' — declared model parameters. - 'part-categories' — top-level part-catalog categories available in the bundled (and configured remote) catalog. - 'part-families' — part families within a category ({ category? }); count + exemplar ids per family. - 'bom' — bill of materials ({ assembly? }): one row per distinct part (grouped by geometry/catalog identity, not name) with real instance quantity, kind ('fabricated'|'purchased'), material, density, per-unit and total mass, bbox, a fabrication process (`process` + `processSource`), catalog provenance for purchased parts, and totals; `bom.*` diagnostics flag rows with no density source or missing catalog vendor info instead of guessing. - 'section' — numeric cross-section probe of a shape: area, perimeter, loop/hole counts, 2D bbox at a plane ({ feature_id?, plane | at+axis, stack?: { from, to, count, axis? } }). `stack` scans evenly spaced slices and returns `minAreaIndex`/`minAreaPosition` — use it to find the neck/thinnest cross-section along an axis. - 'continuity' — G0/G1/G2 classification of shared edges ({ feature_id?, edges? }); position gap, normal jump, curvature difference, worst-sample XYZ. - 'curvature' — per-face Gaussian and mean curvature min/max/mean, inflections, spikes ({ feature_id?, faces?, spike_factor? }). - 'multi-material' — explicit material leaves shadowed by later attributed boolean descendants, with assembly-part rewrite templates; analyzes capture records and does not change mesh attribution. All params except `of` are subject-specific and forwarded verbatim. Most subjects accept { file | code }. Hosted: give the file as an https:// URL, a data: URI (base64, max 25 MB) or "asset:<id>" from request_upload (when the file is on the user's device).
Use this when you need the captured NURBS definition for a kernelCAD nurbsCurve/spline3d feature. Returns degree, distinct knots and multiplicities, poles, weights, rational and uniformWeights flags, hasNonUnitWeights, and parameter range. Defaults to the last captured curve; pass feature_id to choose one. Reports authored data, not exact geometry-derived B-rep edge/face NURBS. Surface extraction and blending are not supported.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| feature_id | string | Optional curve3d FeatureId; defaults to the last captured NURBS curve. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"feature_id": {
"type": "string",
"description": "Optional curve3d FeatureId; defaults to the last captured NURBS curve."
}
}
}Use this when you need to list the kernelCAD script-runtime surface: global functions (box, path, selectEdges, helix, etc), Shape methods (fillet, sweep, lower, etc), Sketch methods (extrude, revolve, sweep), PathBuilder methods, EdgeQuery/FaceQuery key sets, and featureKindFaceLabels (which globals accept opts.faceLabels and valid value shapes). Use this to discover what is callable from a .kcad.ts script. Call this BEFORE concluding kernelCAD lacks a capability — its NURBS freeform surfacing (loft, sweep, boundary-fill, G2 blend) is easy to miss from tool names alone.
| Argument | Type | Description |
|---|---|---|
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
{
"type": "object",
"properties": {
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
}
}
}Return the kernelcad-authoring skill — conventions for writing .kcad.ts scripts (API surface, parameters, evaluation contract, common pitfalls) — in sections. Call with NO arguments first: you get the quick-start (units, axes, the return rule, the rules that prevent most failures, the intent → API routing table, the "Before you finish" checklist) and an index of every section with a one-line summary (under 16k chars). Then pull what you need: `{ section: "<id>" }` returns one section (e.g. "top-level-functions", "materials", "dfm-gates-print-readiness"); `{ query: "fillet after subtract" }` returns the best-matching sections. `{ section: "all" }` returns the full ~140k-char skill (SKILL.md plus its reference files) — only if your client accepts large responses. Clients that list resources can also read `kernelcad://skills/authoring` (the SKILL.md core). OUTPUT: { uri, mimeType, mode, text, sections? } — `mode` is index | section | search | all | not-found.
| Argument | Type | Description |
|---|---|---|
| query | string | Keywords to search section titles and bodies (e.g. "sweep along helix"). |
| topic | string | Alias of section; also accepts a loose title such as 'materials' or 'cli commands'. |
| section | string | Section id from the index (e.g. 'top-level-functions'), or 'all' for the full skill. |
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Keywords to search section titles and bodies (e.g. \"sweep along helix\")."
},
"topic": {
"type": "string",
"description": "Alias of section; also accepts a loose title such as 'materials' or 'cli commands'."
},
"section": {
"type": "string",
"description": "Section id from the index (e.g. 'top-level-functions'), or 'all' for the full skill."
}
}
}Use this when you need a canonical pattern snippet for a CAD task. Search the kernelCAD cookbook for canonical pattern snippets. Returns top-k snippets matching the natural-language query, ranked by BM25 over title/tags/keywords/trigger. Use when you need a canonical pattern for fillet-after-subtract, non-overlapping booleans, sketch-to-extrude flows, etc. Returns empty if no snippet scores above the relevance floor — proceed without cookbook help in that case.
| Argument | Type | Description |
|---|---|---|
| k | number | Max snippets to return. Default 3, max 5. |
| id | string | Exact snippet id as the skills cite it (e.g. "clearance-hole-through-plate"); returns that snippet. An unknown id is ranked as a query. |
| query | string | Natural-language description of what you want to do (e.g. "round the rim of a hole", "build an L-bracket"). One of query / id is required. |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
{
"type": "object",
"properties": {
"k": {
"type": "number",
"default": 3,
"description": "Max snippets to return. Default 3, max 5."
},
"id": {
"type": "string",
"description": "Exact snippet id as the skills cite it (e.g. \"clearance-hole-through-plate\"); returns that snippet. An unknown id is ranked as a query."
},
"query": {
"type": "string",
"description": "Natural-language description of what you want to do (e.g. \"round the rim of a hole\", \"build an L-bracket\"). One of query / id is required."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
}
}
}Use this when you need the kernelCAD 26-code diagnostic catalogue with hint templates. Tiny one-shot call; useful for an agent that wants to pre-populate retry strategies. Hints are also inline on every emitted diagnostic — this tool just gives you the canonical list up front.
No arguments.
{
"type": "object",
"properties": {}
}Use this when the user wants to union, subtract, or intersect two imported triangle mesh solids (STL, OBJ, or 3MF). Supports union, subtract (A minus B) and intersect. Pass each operand as { file } on the MCP server or { data } with base64 mesh bytes; formats are detected or may be specified. Returns volume in mm³, triangle count and a binary STL as data_base64; pass that payload to import_step to continue modeling. Inputs must be closed, consistently oriented 2-manifold meshes. Open, non-manifold, or invalid meshes return an error. This computes mesh geometry and does not create an editable B-rep feature tree.
| Argument | Type | Description |
|---|---|---|
| a* | object | First mesh: { file } or { data } base64, optional format stl|obj|3mf. |
| b* | object | Second mesh: { file } or { data } base64, optional format stl|obj|3mf. |
| operation* | string | |
| toleranceMm | number | Vertex weld tolerance in mm. Default 0.000001. |
| maxTriangles | integer | Maximum triangles per input and output. Default and maximum 100000. |
{
"type": "object",
"required": [
"operation",
"a",
"b"
],
"properties": {
"a": {
"type": "object",
"description": "First mesh: { file } or { data } base64, optional format stl|obj|3mf."
},
"b": {
"type": "object",
"description": "Second mesh: { file } or { data } base64, optional format stl|obj|3mf."
},
"operation": {
"enum": [
"union",
"subtract",
"intersect"
],
"type": "string"
},
"toleranceMm": {
"type": "number",
"description": "Vertex weld tolerance in mm. Default 0.000001."
},
"maxTriangles": {
"type": "integer",
"description": "Maximum triangles per input and output. Default and maximum 100000."
}
}
}Mesh a kernelCAD .kcad.ts source server-side and return a COMPACT geometry summary — overall bounds plus, per feature, its id, kind, triangle count, and bounding box. Use this to INSPECT a model's geometry without a viewer: confirm a part is the size/shape you expect, see how many triangles each feature contributes, or check that every feature produced geometry. This runs the full server-side OCCT pipeline (the same one the Studio renderer uses), so it evaluates modern sources (assembly, path, .material, …) that the legacy client worker cannot. INPUT: `source` (required) the .kcad.ts script text; `fileName` (optional) a label for diagnostics; `params` (optional) a map of parameter-name → number overrides applied before meshing (stateless slider recompute). OUTPUT: { ok, bounds, featureCount, features: [{ id, kind, triangleCount, bbox: { min:[x,y,z], max:[x,y,z] } }], failedFeatureIds, diagnostics }. `ok` is true when every feature meshed; `failedFeatureIds` lists features that failed to compile (and `ok` is then false). Raw vertex/index/normal arrays are NEVER returned — this is a summary only. To SEE the rendered model, call open_in_studio (includes PNG preview + viewer); use get_latest_render only for alternate views.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional map of parameter-name → numeric value, applied as overrides before meshing (stateless slider recompute). |
| source* | string | The .kcad.ts script source to mesh. |
| fileName | string | Optional file-name label used in diagnostics (does not affect geometry). |
{
"type": "object",
"required": [
"source"
],
"properties": {
"params": {
"type": "object",
"description": "Optional map of parameter-name → numeric value, applied as overrides before meshing (stateless slider recompute).",
"additionalProperties": {
"type": "number"
}
},
"source": {
"type": "string",
"minLength": 1,
"description": "The .kcad.ts script source to mesh."
},
"fileName": {
"type": "string",
"description": "Optional file-name label used in diagnostics (does not affect geometry)."
}
},
"additionalProperties": false
}Use this when you are handed an STL, OBJ or 3MF of a mostly prismatic mechanical part (plate, bracket, spacer, flange, housing block) and need an EDITABLE kernelCAD model of it rather than a faceted lib.fromSTL import. Deterministic, measured, self-verifying: it welds and checks the mesh, segments planes and cylinders, picks the extrusion axis, slices each band and fits exact lines / arcs / circles, snaps near-round values (each snap recorded), then emits a readable .kcad.ts with named param()s — a revolve for concentric round stacks, extruded profiles otherwise, .hole()/.holes() for through, blind and counterbored bores (axial and side-drilled), .cutout() for pockets, .fillet() for constant-radius edge blends (radius measured on the sharp edge, edges grouped by radius and picked with the shortest exact edge query), boolean subtractions for what no drilling feature can reach. It then EVALUATES that script and compares it with the mesh: volume IoU (column ray casting) and symmetric surface deviation (max + RMS), over up to 4 refinement passes. Returns { script, ledger, fidelity: { maxDeviationMm, rmsMm, volumeIoU, verdict: faithful | approximate | failed, thresholds }, unmatchedRegions, features, passes }. A fillet or sharp reading is kept by which measures better; variable-radius blends and chamfers are reported, not forced. The verdict is computed from the numbers — faithful needs IoU >= minIoU AND max deviation <= maxDeviationMm AND a watertight mesh AND no unmatched region. Freeform surfaces, tilted planes and side bosses are listed in unmatchedRegions (reference.mesh.freeform-region-unmatched), never silently dropped. The ledger uses fact ids equal to param names, so resolve_assumptions on the written <out>.ledger.json yields paramOverrides for set_param. Pass { out } to write the script and ledger; the mesh itself is never modified. Hosted: give the file as an https:// URL, a data: URI (base64, max 25 MB) or "asset:<id>" from request_upload (when the file is on the user's device).
| Argument | Type | Description |
|---|---|---|
| out | string | Write the emitted script to this .kcad.ts path and the assumption ledger to the sibling .ledger.json. |
Save the model as a kernelCAD project AND show it: persists a project revision, returns the interactive Studio viewer (MCP Apps / ChatGPT outputTemplate), and includes a PNG preview in the SAME tool result (image content + previewUrl when available). ONE VIEWER PER PROJECT PER RESPONSE: every call renders a new viewer card. Do all validation with evaluate_script first, then call open_in_studio exactly once, after validation succeeds; reuse the returned URL, revision and preview, and never call it again after a successful result in the same response. Re-calling with unchanged code for the same project returns that revision instead of writing a new one. CONTINUE, DO NOT DUPLICATE: to change a model you already saved, pass `project: '<slug>'` from the last result (or from list_my_projects) — this adds a revision to that project. Without `project`, the save goes to the project this chat already saved, or to your project with the same title (case, punctuation and v2/rev3/(1) ignored) from the last 24 h. Views, poses, colours and options of one design are revisions of ONE project — keep the same title and slug. Pass `new_project: true` only when the user wants a separate design. A different cookbook (execute_cookbook, or open_in_studio of that cookbook's unchanged source) starts its own project; pass `project` to add a revision, or `continue_design: true` to keep revising the design this chat is already saving. The result starts with the slug to pass next time, a /p/<slug>?version= link for this revision, and that revision's title. Use this when the user wants to SEE or share the model — do NOT call get_latest_render afterwards for the happy path; the preview is already here when previewDelivered is true. Pass the full `.kcad` source as `code` (optional if you just called evaluate_script — omitting reuses that last evaluated source). Code that fails evaluate_script (for example overlapping same-material members or floating pieces) is refused; fix it first. A broken mechanism verdict alone does NOT refuse: the revision is saved, Studio shows "Mechanism broken", and the result returns mechanismSummary (statement, maxLevel, failures with the joint). Tell the user the mechanism is broken; do not call it working. Multi-body assemblies must declare connectors + mates/joints before publish — otherwise evaluate_script fails with mechanism.orphan-part (disconnected components). Use type: 'axis' + revolute mates for shafts/hinges/gears; type: 'frame' + fastened for rigid mounts; or arm.revolute/.prismatic/.ball/.fixed. Connector types are only frame|axis|planar|ball. Status fields: ok=true means the project revision was saved (projectSaved=true). meshSaved reports whether its display mesh is persisted; meshStatus=failed means meshSaved=false, but the saved project remains usable for geometry checks. Do not claim its 3D viewer is ready. previewDelivered=true means this result carries a displayable PNG — only then may you tell the user a preview was shown. meshStatus mirrors get_project (ready|building|failed|missing). Under CDN, open_in_studio waits up to ~20s (OPEN_IN_STUDIO_MESH_SYNC_BUDGET_MS) for the revision mesh before returning; heavier publishes usually land meshStatus=ready. If still meshStatus=building + meshReady=false: TRANSIENT — meshUrl is the expected CDN pin; embed retries 404s. Poll get_project({slug}) until ready (it shows no viewer) — do not re-call open_in_studio, and never treat building as permanent failure/404. ALWAYS pass `code` when you have it (avoid no_code_to_reuse); evaluate_script reuse is a fallback. Paint phases: projectSaved / meshReady / previewDelivered are set here; viewerPainted is ONLY true after widget ack (model context / widgetState) — never claim paint from this tool alone. Do NOT call get_model_mesh or get_latest_render for interactive paint. INDEPENDENT OF EXPORT/STEP: call this for shaded paint even while export is running, timed out, or returned export.deferred — mesh paint does not wait on STEP. Never block open_in_studio on a STEP download. Pass include_preview:false to skip the rasterizer (save + viewer URLs only). Trigger phrases: "open it in Studio", "let me see it", "show me the model"; also call once after you finish a build, and once per response after each meaningful revision while iterating. ORGANIC/CAR SUCCESS GATE: for final likeness claims pass likeness_profile:"automotive" (and body_bbox/wheels/still_verdicts, or a prior verify body-likeness pass for this code). If the gate fails, ok:false with DX reference.likeness.publish-blocked|gate-required — do not claim success. Omit likeness_profile for WIP previews only. Declare dimensions in the source with shape.dimension({ kind, from, to, label }) (label is a name; the measured value is appended) and they show on the model in every viewer; add ?dims=1 to a /p link to force dimensions on. MARK & FIX: a user message starting `Edit kernelCAD project <slug> (revision N): "<note>". Targets: #1 feature "<id>" ...` comes from pins the user tapped in the viewer. Feature/part ids are the script's own feature and part names (assembly part names, named shapes); points are world mm. Call get_project with that slug, change only the named features near those points, keep everything else, then open_in_studio with project set to the same slug. Hosted: lib.fromSTEP / fromSTL / fromDXF / fromSVG and referenceImage take a direct string literal or a const bound to one (computed expressions are unsupported). They accept "asset:<id>" (from request_upload), an https:// URL or a data: URI as the path.
Order the part made: creates the production request and returns a pay_url for the user. Propose the manufacturing method from the user's words and the part, pass it as method with a one-line reason. The price is the real maker price; never invent or send one. Tell the user the card is only held, and a person confirms the final price before charging. If the result is status "pricing", the price is still being worked out: call again in a few seconds.
| Argument | Type | Description |
|---|---|---|
| slug | string | Saved project slug (from open_in_studio or a /p/<slug> link). Send slug or source, not both. |
| method | object | How the part should be made. Propose it from the user's words and the part (flat sheet: laser_cut or sheetmetal; metal block: cnc; plastic: fdm_print or resin_print). |
| source | string | The kernelCAD script, when the part is not saved. Send slug or source, not both. |
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Saved project slug (from open_in_studio or a /p/<slug> link). Send slug or source, not both."
},
"method": {
"type": "object",
"required": [
"process"
],
"properties": {
"reason": {
"type": "string",
"description": "One line: why this method."
},
"process": {
"enum": [
"laser_cut",
"sheetmetal",
"cnc",
"fdm_print",
"resin_print"
],
"type": "string"
},
"material": {
"type": "string",
"description": "Only a material the user named."
},
"quantity": {
"type": "integer",
"maximum": 10000,
"minimum": 1
}
},
"description": "How the part should be made. Propose it from the user's words and the part (flat sheet: laser_cut or sheetmetal; metal block: cnc; plastic: fdm_print or resin_print).",
"additionalProperties": false
},
"source": {
"type": "string",
"description": "The kernelCAD script, when the part is not saved. Send slug or source, not both."
}
},
"additionalProperties": false
}Start or read the real price for making the part. Cheap. Returns status "ready" with estimate_cents and summary, or "pricing" while the makers are asked (call again in a few seconds). Creates nothing and charges nothing.
| Argument | Type | Description |
|---|---|---|
| slug | string | Saved project slug (from open_in_studio or a /p/<slug> link). Send slug or source, not both. |
| method | object | How the part should be made. Propose it from the user's words and the part (flat sheet: laser_cut or sheetmetal; metal block: cnc; plastic: fdm_print or resin_print). |
| source | string | The kernelCAD script, when the part is not saved. Send slug or source, not both. |
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Saved project slug (from open_in_studio or a /p/<slug> link). Send slug or source, not both."
},
"method": {
"type": "object",
"required": [
"process"
],
"properties": {
"reason": {
"type": "string",
"description": "One line: why this method."
},
"process": {
"enum": [
"laser_cut",
"sheetmetal",
"cnc",
"fdm_print",
"resin_print"
],
"type": "string"
},
"material": {
"type": "string",
"description": "Only a material the user named."
},
"quantity": {
"type": "integer",
"maximum": 10000,
"minimum": 1
}
},
"description": "How the part should be made. Propose it from the user's words and the part (flat sheet: laser_cut or sheetmetal; metal block: cnc; plastic: fdm_print or resin_print).",
"additionalProperties": false
},
"source": {
"type": "string",
"description": "The kernelCAD script, when the part is not saved. Send slug or source, not both."
}
},
"additionalProperties": false
}Use this when you need to wrap a 2D closed curve onto a 3D face. Insert a `<shape>.projectCurve({ source, face, scaleMode? })` chained call into a kernelCAD script. The `source` is the structured `{ kind: "sketchCommands", commands: [...] }` wire format the runtime API accepts. Wraps the curve onto the face along the face normal; pair with `.extrude(d)` / `.cut(...)` for raised or engraved logos on curved bodies. Open-wire projection (`asEdge: true`) is not implemented and is rejected at edit time. Side-effect-free; returns modified code plus diagnostics.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| face* | string | Target face — canonical name or label. |
| asEdge | boolean | Open-wire (edge) projection. NOT IMPLEMENTED — rejected at edit time. Use a closed-curve projection (omit asEdge). |
| bindAs | string | Optional local variable name; emits `const <bindAs> = <target>.projectCurve(...);`. |
| target* | string | Variable name of the Shape to chain onto. |
| commands* | array | Closed 2D path to wrap onto the face, as plain-number commands. Must start with a `moveTo` and end with a `close` (e.g. [{kind:"moveTo",x:0,y:0},{kind:"lineTo",x:2,y:0},{kind:"lineTo",x:2,y:2},{kind:"close"}]). |
Use this when you need to resolve or inspect topology against a script's lowered geometry. Pass the script as `code` (inline; works on a hosted server) or `file`. Selected by `mode` (default 'evaluate'): - 'evaluate' — list the faces a Query matches ({ query }). Pass expect:'unique' to assert exactly-one. - 'resolve' — resolve one ref to one face ({ ref }). - 'lineage' — the creating/modifying history of a face ({ ref }; feature_id defaults to the last feature). Query forms (faces only; edge/vertex kinds return query.unsupported-entity-type): - a bare face label: 'top', 'bottom', 'left', 'right', 'front', 'back', or a hole/cutout slot like 'wall'. - @kc[<feature-id>/face/<label>] — feature ids are the ones refs print, e.g. '@kc[box_1/face/top]', '@kc[hole_1/face/wall]'. - @kcq[face(<filter>, ...)] — filters AND together: createdBy("box_1"), withLabel("top"), geometryType(PLANE|CYLINDER|CONE|SPHERE|TORUS|BSPLINE_SURFACE), closestTo([x,y,z]) or closestTo([x,y,z], k), containsPoint([x,y,z]); combine with union(a, b), intersection(a, b), subtraction(a, b). Example: '@kcq[face(geometryType(CYLINDER), closestTo([0,0,10]))]'. Each matched face comes back with its canonical @kc ref, centroid, normal and area.
| Argument | Type | Description |
|---|---|---|
| ref | string | mode:'resolve'|'lineage' — one face: '@kc[box_1/face/top]', '@kcq[...]', or '<feature-id>.<label>' (lineage). |
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| mode | string | Resolution mode (default 'evaluate'). |
Use this when you need the faces a ray hits in a local Studio model, nearest first, with points, distances, and normals. Inputs are model units (mm); direction is normalized. Requires the local Studio URL and session token for the same script, reads the current model generation, and returns a set_selection argument object with every hit. feature_id must identify a displayed terminal shape; intermediates have no current viewer shapeIndex. Intersections use the viewer per-face tessellation, so curved-surface points and normals are mesh approximations.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| origin* | array | Ray origin [x, y, z] in model units. |
| session* | string | Studio sessionToken for this script, from GET /__kernelcad/session?script=<path>. |
| direction* | array | Nonzero ray direction [x, y, z]; normalized internally. |
| feature_id | string | Displayed terminal feature to ray-pick; defaults to the returned feature. Intermediate features are not available as current viewer selections. |
Use this when you need to remove a feature line from a script. Remove a single line from a kernelCAD script identified by a substring match. Returns the modified code plus diagnostics from re-evaluating. Refuses to remove the line containing the return statement. Side-effect-free.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| match* | string | A substring that uniquely identifies the line to remove (e.g. `const hole = cylinder(5,`). |
{
"type": "object",
"required": [
"code",
"match"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"match": {
"type": "string",
"description": "A substring that uniquely identifies the line to remove (e.g. `const hole = cylinder(5,`)."
}
}
}Use this when you need to LOOK at a kernelCAD model — render its script to deterministic PNG views for visual self-check (the visual half of the evaluate → render → inspect → fix loop), with NO studio or dev server required. Pass { code } (inline source) or { file } (a .kcad.ts path), exactly one. Renders the canonical engineering views (front, right, top, iso — pass { views } for a subset, e.g. ["iso"] for fastest iteration) plus an optional { pose: "<az>,<el>" } arbitrary camera angle (degrees; az=0,el=0 is front, +az rotates CCW around +Z, +el lifts the camera). NO STUDIO / DEV-SERVER REQUIRED: a prebuilt static player (dist/headless-player) is served from an ephemeral local port automatically; a running studio dev server is used as fallback, and { base_url } forces one. The only environment dependency is playwright chromium (npx playwright install chromium). Pass { focus } or { hide } (arrays of feature ids or assembly part names, mutually exclusive) to isolate parts — same semantics as `kernelcad render --focus/--hide`. Pass { section: { axis, position, flip? } } to cut a cross-section and inspect INTERIOR geometry (wall thickness, internal pockets, whether a bore runs through) rather than only the outer shell. Pass { explode: { factor, mode? } } to pull a multi-part assembly apart (mode: "mate-axis" default, or "radial") using the same mesher as `kernelcad render --explode` — requires assembly.model()/solvedModel(). PNGs are written to { out_dir } (default: a fresh temp session directory) and returned as absolute paths with per-view camera descriptions (kernelCAD is Z-up). Mechanism truth runs first, same protocol as `kernelcad render`: a broken mechanism still renders but every tile is watermarked MECHANISM BROKEN (KERNELCAD_RENDER_STRICT=1 refuses instead); read { mechanism, mechanism_failure_codes }. The probe runs full BREP interference sweeps and can dominate latency on large assemblies — pass { no_mechanism_check: true } for fast iteration (the preview then reports mechanism: "unverified"; ignored under strict mode). Pass { overlay: 'zebra' | 'curvature' | 'continuity' } for a surface-quality visualisation (zebra stripes from vertex normals, curvature as vertex colours, continuity edges coloured by G0/G1/G2/broken) — numbers come from inspect({ of: 'continuity' | 'curvature' }); the overlay is the picture. PUBLISH PRESET: pass { preset: 'publish' } for a share-ready studio product shot (gallery tile, social post, README image, product page): key/fill/rim lights + room reflections, soft contact shadow, clean backdrop ({ background: 'white' (default) | 'light' | 'dark' | 'black' | '#rrggbb' | 'transparent' } — transparent gives a PNG with alpha), { shadow: false } to drop the shadow, 2× supersampled anti-aliasing, 30° lens, the model silhouette centred and auto-framed with ~11% air (a script's setCameraTarget is ignored), per-part colours/materials as authored, no watermark. With no views/pose it renders ONE image named 'hero' (3/4 front-right, az=30°, el=22°) at 1600×1200; width/height go up to 2048; views/pose still work under the preset. Output is deterministic for the same input. For a 360° loop use capture_animation({ turntable: true }). INSPECTION SHEET: { sheet: true } renders all seven views (iso, front, back, left, right, top, bottom) and adds one labelled image named 'sheet' tiling them — do not call a model done because it compiled; call it done when every tile of the sheet matches the request. Returns { ok, images: [{ name, path, description }], out_dir, bounds, mechanism, render_source, render_ms, diagnostics }. PATHS ARE LOCAL to the machine running the MCP server — local stdio clients read them directly; hosted/remote clients should use open_in_studio instead. Hosted server: the PNGs come back IN the result as image content (up to ~1.5 MB total; larger sets are link-only) and each `images[i].url` is an HTTPS link that expires after 24 h. `images[].path` is a server-side path you cannot open. Works without saving a project (autosave:false is fine). Hosted: lib.fromSTEP / fromSTL / fromDXF / fromSVG and referenceImage take a direct string literal or a const bound to one (computed expressions are unsupported). They accept "asset:<id>" (from request_upload), an https:// URL or a data: URI as the path.
Use this when evaluate_script reported an error and you want the fix applied rather than described. Takes the candidates why_did_this_fail derives for a diagnostic, applies them one at a time, re-evaluates after each, and keeps the first that clears the diagnostic without introducing new errors. Never edits outside the repair region (failing feature statement + its input statements + the param() lines it reads) — an out-of-region patch is refused with tool.repair.out-of-region. Returns the repaired source in `new_code` (the caller persists it), a unified `diff`, and before/after health maps. Pass { file? | code?, diagnostic?: '<id>'|'first-error', strategy?: 'apply-first'|'try-all'|'dry-run', max_attempts?: number }.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| strategy | string | 'try-all' (default) walks candidates until one clears the diagnostic; 'apply-first' applies only the top candidate and reports what it did; 'dry-run' previews every candidate patch without evaluating. |
| diagnostic | string | Diagnostic id from why_did_this_fail's `targetDiagnosticId` / `candidates[].diagnosticId`, or 'first-error' (default) for the first error-severity diagnostic. |
Use this when the user has a photo, PDF drawing, STEP, STL, DXF, SVG or 3MF file on their device and you need it in a kernelCAD tool (trace_from_image, drawing_to_cad, mesh_to_features, inspect of:"step", or lib.fromSTEP / fromSTL / fromDXF / fromSVG / referenceImage in a script). Do not ask the user to paste the file as text or base64, and do not type coordinates from an image by hand. Returns a one-time `uploadUrl` (valid 30 minutes) and an `asset` reference. Give the user the link; after they say the upload is done, pass the `asset` value ("asset:<id>") as the file argument, for example trace_from_image({ imageUrl: "asset:<id>" }) or lib.fromSTEP("asset:<id>"). If the file is already at a public https:// URL, pass that URL instead. On clients that support MCP URL elicitation the upload page opens for the user directly and the call returns once the file is stored (status "uploaded"); then use the asset right away without asking the user anything.
| Argument | Type | Description |
|---|---|---|
| purpose | string | Optional short note shown on the upload page, e.g. "the photo of the worn bracket". |
{
"type": "object",
"properties": {
"purpose": {
"type": "string",
"maxLength": 200,
"description": "Optional short note shown on the upload page, e.g. \"the photo of the worn bracket\"."
}
},
"additionalProperties": false
}Use this when you need to confirm or override the open facts in an assumption ledger from trace_from_image (missing scale, inferred/assumed values) before committing geometry built from a reference photo. Reads the persisted `<model>.ledger.json` at `ledgerPath`, applies each resolution — `{ id, confirm: true }` to accept a fact as-is, or `{ id, value }` to override it — rewrites the ledger file, and returns the updated ledger plus `paramOverrides` (factId -> value) to feed straight into `set_param`. Pair with the `kernelcad-from-reference` skill.
| Argument | Type | Description |
|---|---|---|
| ledgerPath* | string | Path to the `<model>.ledger.json` file persisted alongside the traced source. |
| resolutions* | array | One resolution per ledger fact id to act on. |
{
"type": "object",
"required": [
"ledgerPath",
"resolutions"
],
"properties": {
"ledgerPath": {
"type": "string",
"description": "Path to the `<model>.ledger.json` file persisted alongside the traced source."
},
"resolutions": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Matches a `facts[].id` in the ledger."
},
"value": {
"type": [
"string",
"number",
"boolean",
"array",
"object"
],
"description": "Overrides the fact's value; marks it `overridden`."
},
"confirm": {
"type": "boolean",
"description": "Accepts the fact as-is; marks it `confirmed`."
}
}
},
"description": "One resolution per ledger fact id to act on."
}
}
}Use this when you need to review a mechanism for fitness and repair mode. Run the deterministic CAD review loop: evaluate the script, validate the assembly/mate graph, check mate connectors touch modeled material, sample declared mate limits, optionally check interferences at sampled poses, report connector workspace bounds, and return a mechanism fitness verdict for agent self-review. Fitness includes repairMode: none, local-fix, parameter-tune, or topology-redesign. Runs within timeBudgetMs (default 90 s): stages that did not fit are listed in skippedStages (their checks did not run; mechanism is then unverified) and stageTimingsMs shows per-stage cost. Hosted: lib.fromSTEP / fromSTL / fromDXF / fromSVG and referenceImage take a direct string literal or a const bound to one (computed expressions are unsupported). They accept "asset:<id>" (from request_upload), an https:// URL or a data: URI as the path.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| assembly | string | Assembly name; defaults to the first captured assembly. |
| designGoal | string | Original user design prompt or goal. Included in suggestedRepairPrompt so topology-redesign repairs restart from the intended physical design instead of local coordinate nudges. |
| epsilonMm3 | number | Interference volume threshold in mm^3. Default 0.01. |
Return the newest brush-painted review packet from a Studio session. After sharing a /p/<slug> link, the user can open it in the browser and paint marks over the 3D viewport to give visual feedback. Call this tool with the `slug` from that link to see the strokes — screenshot + mask + struck part names plus an optional one-line note and intent tags (e.g. "too thick", "missing", "wrong angle") describing WHAT is wrong — and act on the feedback. The slug is the capability: no OAuth required when passing `slug`; private projects require the owner to be signed in. Omit `slug` to fetch your own latest packet from your signed-in account (requires OAuth). By default returns short-lived signed Storage URLs for the screenshot + mask + meta.json plus the struck part names — small and context-friendly. Pass `paths_only: false` to also base64-inline the PNGs for clients that cannot fetch the signed URLs over HTTP.
| Argument | Type | Description |
|---|---|---|
| slug | string | Project slug from open_in_studio/get_project/a /p/<slug> link. When given, returns the latest brush packet painted on that project's page — works without OAuth; the slug is the capability. Omit to use your signed-in account's latest packet. |
| paths_only | boolean | Controls PNG delivery. Default (omitted or true): return only signed URLs + struck part names — the small, context-friendly response; fetch the bytes via the signed URLs. Set false to also base64-inline the screenshot + mask PNGs for clients that cannot fetch the URLs over HTTP (larger response). |
| freshness_sec | integer | Maximum packet age in seconds. Default 1800 (30 min). Use a smaller value for "what did I just paint" or a larger one for "earlier today". |
Use this when you need a first-pass orthogonal pin-to-pin wire route estimate and clearance check. Accepts a LabWired handoff or explicit wire positions in millimetres, returns path length and bend count, and reports collisions against part bounding boxes. Wires whose endpoint positions are null are reported as unresolved. Read-only analysis; it does not create or certify a physical harness.
| Argument | Type | Description |
|---|---|---|
| wires | array | Wire records with from_pos_mm and to_pos_mm as 3D millimetre coordinates. |
| handoff | object | LabWired handoff schema labwired-kernelcad-handoff/0.1 with parts, pins and wires. |
| obstacles | array | Axis-aligned obstacle volumes in world millimetres. |
| clearance_mm | number | Minimum obstacle clearance, default 1 mm. |
| bend_radius_mm | number | Requested minimum bend radius, default 2 mm. |
| board_surface_z_mm | number | Known world Z of the LabWired board surface. Required to reconcile 2D endpoint coordinates and XY-only part placements for complete clearance analysis. |
{
"type": "object",
"properties": {
"wires": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Wire records with from_pos_mm and to_pos_mm as 3D millimetre coordinates."
},
"handoff": {
"type": "object",
"description": "LabWired handoff schema labwired-kernelcad-handoff/0.1 with parts, pins and wires.",
"additionalProperties": true
},
"obstacles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Axis-aligned obstacle volumes in world millimetres."
},
"clearance_mm": {
"type": "number",
"description": "Minimum obstacle clearance, default 1 mm."
},
"bend_radius_mm": {
"type": "number",
"description": "Requested minimum bend radius, default 2 mm."
},
"board_surface_z_mm": {
"type": "number",
"description": "Known world Z of the LabWired board surface. Required to reconcile 2D endpoint coordinates and XY-only part placements for complete clearance analysis."
}
}
}Use this when you need to know whether a part will hold a load. Runs a linear-static structural study and returns evidence — peak von Mises stress (MPa), peak displacement (mm), the minimum safety factor against the material yield (taken away from the clamp-singular edges of the fixed faces; the raw clamp-edge peak is reported separately as peakAtSupportMPa), per-region hot spots named by @kc[...] face ref, mesh trust flags, an equilibrium residual, and (CalculiX only) stress-heatmap PNG paths. The study is EITHER declared in the script with `shape.feaStudy({ material, fixed, loads, meshSize?, minSafetyFactor? })` OR passed on the call against the shape the script returns: { code: 'return box(100, 20, 10);', material: 'aluminum-6061', fixed: { atX: 0 }, loads: [{ faces: { atX: 100 }, force: [0, 0, -200] }] }. Faces are a FaceQuery ({ atX | atY | atZ, byNormal: 'Z', ofSurfaceType, near: [x,y,z], ... }; with near it names the ONE matching face nearest the point), a face label ('top', 'bottom', 'left', 'right', 'front', 'back'; it must name ONE face — after a boolean 'top' can be several, which is an error listing them) or an @kc[...] ref. Force is the TOTAL [Fx, Fy, Fz] in N on those faces (a scalar force + direction is accepted). Materials: mild-steel, aluminum-6061, pla, petg, abs, nylon (aliases steel, aluminum), or { E, nu, yield } in MPa. Solver (`solver`, default 'auto'): CalculiX + gmsh quadratic tets when that toolchain is installed; otherwise the built-in in-process voxel solver (8-node incompatible-mode bricks), which needs nothing installed and is marked summary.solver 'in-process-voxel' with trust.meshTrusted false — an estimate (accurate for prismatic bending, approximate at curved faces and notches), never a verified pass. solver: 'calculix' fails up front with fea.solver.unavailable and the install command when the toolchain is absent. Also: `study` (a declared study name; default the last), `output_dir` (keeps the deck / summary JSON), `mesh_size` (mm, overrides the study for this run), `heatmaps: false` for a numbers-only run. CalculiX mesh refinement is automatic: when the stress is untrusted only because the solver's error estimate is high, it re-solves once at 0.75x the element size (inside the element budget), with summary.refinement listing each pass. `refine: false` solves once.
| Argument | Type | Description |
|---|---|---|
Use this when you need to upload a .gcode file (e.g. written by export with target: "model", format: "gcode") to a real network printer and, by default, start the print. protocol: 'octoprint' (POST /api/files/local with an X-Api-Key), 'moonraker' (Klipper's POST /server/files/upload), or 'bambu-lan' (Bambu Lab LAN-mode: FTPS implicit-TLS upload on port 990 as user 'bblp' with the printer's LAN access code, then an MQTT print-start command on port 8883 — requires access_code and, unless start_print is false, serial). bambu-lan uploads a .gcode.3mf print project (the printer prints 3MF projects, not bare G-code): the G-code goes in as Metadata/plate_1.gcode, inside the model 3MF from export format '3mf' when model_3mf_path is given (use options { arrange: 'plate', slicer: 'bambu' } so the printer shows the same named, coloured parts), else inside a minimal 3MF shell; the file name always ends in .3mf ('part.gcode' -> 'part.gcode.3mf'). Optional printer (a bundled profile id, the same ids as the export 3mf/gcode options.printer) is checked against protocol before anything is read or sent: an unknown id is refused with the list of valid ids, 'bambu-lan' needs a Bambu Lab profile and a Bambu Lab profile needs 'bambu-lan'. Pass { dry_run: true } to validate connectivity/authentication only, without uploading or starting a print. Never logs or echoes api_key/access_code.
| Argument | Type | Description |
|---|---|---|
| host* | string | Printer hostname or IP. |
| port | number | Override the protocol default port. |
| serial | string | Bambu printer serial number (required to start a print unless start_print is false). |
| api_key | string |
Use this when you need to edit a param() default value in a kernelCAD script. Returns the modified code as text plus diagnostics from re-evaluating the result. Caller persists the new code via standard file-write tools (this tool has no side effects).
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| new_value* | any | The new default value. Either a number for a numeric param (e.g. 12.5), or a string expression evaluated in the script (e.g. "width/2 + 3"). |
| param_name* | string | The string literal name of the param (first arg to param()). |
{
"type": "object",
"required": [
"code",
"param_name",
"new_value"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"new_value": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"examples": [
12.5,
"width/2 + 3"
],
"description": "The new default value. Either a number for a numeric param (e.g. 12.5), or a string expression evaluated in the script (e.g. \"width/2 + 3\")."
},
"param_name": {
"type": "string",
"description": "The string literal name of the param (first arg to param())."
}
}
}Use this when you need to set how the script returns its assembly. Replace the final top-level return statement with `return <assembly>.model();` or `return <assembly>.solvedModel(poses, options?);`. Use solvedModel for mate-authored mechanisms so FK and validation run. Returns modified source plus diagnostics from re-evaluation.
| Argument | Type | Description |
|---|---|---|
| code* | string | The .kcad.ts source code. |
| mode* | string | |
| poses | object | Optional solvedModel pose overrides keyed by mate name. Defaults to {}. |
| options | object | Optional solvedModel options such as { validate: 'warn', posesGate: 'envelope' }. |
| assembly_binding* | string | JS identifier bound to assembly(...). |
{
"type": "object",
"required": [
"code",
"assembly_binding",
"mode"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"mode": {
"enum": [
"model",
"solvedModel"
],
"type": "string"
},
"poses": {
"type": "object",
"description": "Optional solvedModel pose overrides keyed by mate name. Defaults to {}."
},
"options": {
"type": "object",
"description": "Optional solvedModel options such as { validate: 'warn', posesGate: 'envelope' }."
},
"assembly_binding": {
"type": "string",
"description": "JS identifier bound to assembly(...)."
}
}
}Use this when you need to replace the shared local Studio face/edge selection, or clear it with selection:null. The viewer highlights the pick on its next sync (300 ms). Does not edit geometry. Pass model_generation from get_selection; writes from an older generation are rejected. Use only current shape indices. Requires a local Studio session.
| Argument | Type | Description |
|---|---|---|
| session* | string | Studio sessionToken from GET /__kernelcad/session?script=<path>. Use the same script as the viewer. |
| selection* | any | |
| studio_url* | string | Local Studio HTTP origin, e.g. http://localhost:5173. |
| model_generation* | integer | modelGeneration from get_selection; rejects picks from a prior mesh. |
{
"type": "object",
"required": [
"studio_url",
"session",
"model_generation",
"selection"
],
"properties": {
"session": {
"type": "string",
"description": "Studio sessionToken from GET /__kernelcad/session?script=<path>. Use the same script as the viewer."
},
"selection": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"required": [
"shapeIndex",
"kind",
"id",
"featureId"
],
"properties": {
"id": {
"type": "integer",
"minimum": 0
},
"kind": {
"enum": [
"face",
"edge"
],
"type": "string"
},
"featureId": {
"type": [
"string",
"null"
],
"minLength": 1
},
"shapeIndex": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
},
"studio_url": {
"type": "string",
"description": "Local Studio HTTP origin, e.g. http://localhost:5173."
},
"model_generation": {
"type": "integer",
"minimum": 0,
"description": "modelGeneration from get_selection; rejects picks from a prior mesh."
}
}
}Use this when you need to solve the mate graph and get part poses. Run the v0.6 mate-graph solver on the active assembly. Returns { status, poses, iterations? } where each pose is a serialized Transform ({ translation, rotateAxis, rotateDeg }). Optional poses overrides mate pose values by mate name.
| Argument | Type | Description |
|---|---|---|
| poses | object | Optional numeric pose overrides keyed by mate name. |
| assembly | string |
{
"type": "object",
"properties": {
"poses": {
"type": "object",
"description": "Optional numeric pose overrides keyed by mate name."
},
"assembly": {
"type": "string"
}
}
}Use this when you need to solve a 2D sketch constraint set. Solve a 2D sketch constraint set. Side-effect-free: pass { entities, constraints } and receive solved entities plus the original constraints. Entities are POINT, LINE, and CIRCLE records; constraints use the kernelCAD constraint vocabulary.
| Argument | Type | Description |
|---|---|---|
| entities* | array | Sketch entities to solve. Lines reference point ids; circles reference a center point id. |
| constraints* | array | Constraints to apply to the entities. |
{
"type": "object",
"required": [
"entities",
"constraints"
],
"properties": {
"entities": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"id",
"type",
"x",
"y"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"POINT"
],
"type": "string"
},
"fixed": {
"type": "boolean",
"description": "If true, the solver won't move this point."
}
},
"description": "POINT — a 2D point."
},
{
"type": "object",
"required": [
"id",
"type",
"p1",
"p2"
],
"properties": {
"id": {
"type": "string"
},
"p1": {
"type": "string"
},
"p2": {
"type": "string"
},
"type": {
"enum": [
"LINE"
],
"type": "string"
}
},
"description": "LINE — references two point ids."
},
{
"type": "object",
"required": [
"id",
"type",
"center",
"radius"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"CIRCLE"
],
"type": "string"
},
"center": {
"type": "string"
},
"radius": {
"type": "number"
}
},
"description": "CIRCLE — references a center point id."
}
]
},
"description": "Sketch entities to solve. Lines reference point ids; circles reference a center point id."
},
"constraints": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"entities"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"COINCIDENT",
"DISTANCE",
"HORIZONTAL",
"VERTICAL",
"PARALLEL",
"PERPENDICULAR",
"EQUAL_LENGTH",
"TANGENT",
"RADIUS",
"ANGLE",
"CONCENTRIC",
"SYMMETRIC"
],
"type": "string"
},
"value": {
"type": "number",
"description": "Required for DISTANCE, RADIUS, and ANGLE."
},
"entities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ids of the entities the constraint relates."
}
}
},
"description": "Constraints to apply to the entities."
}
}
}Use this when you need to check whether a mechanism stays buildable across a tolerance/dimension range, not just at one nominal value. Declares one or more param() names with a { values: [...] } list or a { min, max, steps } range, re-evaluates the script once per cartesian-product combination (capped at 64 combos — exceeding it truncates to the first 64 and emits kinematic.sweep-tolerance.combo-cap-exceeded), and runs the standard gates on each combo: interference, mounting-hole diameter agreement, and joint-axis binding (all three, default on); reachability only when gates.reachable names a tip_link + target. Returns the pass/fail envelope table (one row per combo) plus firstFailure per gate — the fastest way to find the first param value at which a design breaks.
| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| gates | object | Which standard gates to run per combo. |
| params* | object | param() name -> { values: [number|string, ...] } or { min, max, steps }. |
| assembly | string | Assembly name; defaults to the first captured assembly. |
{
"type": "object",
"required": [
"params"
],
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"gates": {
"type": "object",
"properties": {
"jointAxis": {
"type": "boolean",
"description": "Default true."
},
"reachable": {
"type": "object",
"required": [
"tipLink",
"targetPosition"
],
"properties": {
"tipLink": {
"type": "string"
},
"targetPosition": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"targetOrientation": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"description": "Runs the reachability gate when set."
},
"interference": {
"type": "boolean",
"description": "Default true."
},
"mountingHoles": {
"type": "boolean",
"description": "Default true."
}
},
"description": "Which standard gates to run per combo."
},
"params": {
"type": "object",
"description": "param() name -> { values: [number|string, ...] } or { min, max, steps }."
},
"assembly": {
"type": "string",
"description": "Assembly name; defaults to the first captured assembly."
}
}
}Use this when you need to trace a reference image into normalized waypoints, or turn sketch labels into a catalog-aware draft BOM. Trace pixel-space features from a reference photo into normalized [0..1] waypoints the agent can map to mm via a known scale anchor and feed to path().spline / path().nurbsSegment. Set `detectParts: true` to request labeled component boxes, confidence, bundled-catalog candidates and unmatched labels; the BOM is a draft for review. Three backends are dispatched behind the scenes: `opencv` (deterministic; uniform-bg silhouette only), `vision-llm` (vision model; named points/cluttered backgrounds; needs a configured vision endpoint), and `hybrid` (opencv silhouette + LLM-labeled named points). Default backend is `auto`. Per-feature confidence is reported. Pair with the `kernelcad-trace-from-image` skill for the conversion-to-mm pipeline. Hosted: give the file as an https:// URL, a data: URI (base64, max 25 MB) or "asset:<id>" from request_upload (when the file is on the user's device).
| Argument | Type | Description |
|---|---|---|
| hint | string | Optional free-text hint forwarded to vision-LLM backends (e.g. "a pair of eyewear; trace the upper brow only"). |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| priors | array | Caller-supplied category-norm defaults (e.g. wall thickness) recorded verbatim as `assumed` ledger facts. |
| backend | string | Force a specific backend; default `auto` routes by corner-color stddev. |
| features | array |
Use this when you need to check a design against a rule set. One verifier, selected by `check`: - 'assembly' — static assembly review ({ file | code }, or the session evaluate_script left): mate validator, default-pose interference, joint topology, mechanical plausibility. ok:false with `blocking[]` exactly when review_cad's blocking rules fire on these findings; review_cad also sweeps joint ranges and runs physics. - 'urdf' — structural validity of a .urdf file ({ urdf_path }). - 'dfm' — print-readiness gates declared by dfmSpec() ({ file | code }). - 'dfm-preflight' — sheet-metal flat pattern vs a job-shop's ordering rules ({ vendor, material, thicknessIn|thicknessMm, ... }). Returns the vendor's catalog source pages as `sources`; when `disclosure` is present, show it with those links. - 'assembly-path' — continuous straight-line removal of each assembly part along ±X/±Y/±Z and optional world-space directions. Returns valid directions and blocking parts; disassemblyOrder runs a deterministic greedy removal pass. Watertight mesh approximation, conservative contact, no rotation/mate/hardware certification. - 'swept-collision' — sweep declared joint range(s) and report colliding poses. - 'reachable' — inverse-kinematics reachability for an end-effector ({ tip_link, target_position, ... }). - 'geometry-quality' — one solid body's BREP tiny faces and short edges (ids, locations, mm²/mm), plus sampled mirror symmetry about centroid XY/YZ/XZ and principal inertia planes ({ file | code, feature_id?, tiny_face_area_mm2?, tiny_face_relative?, short_edge_length_mm?, symmetry_tolerance_mm?, mesh_deflection_mm?, asserted_plane?: { origin, normal } }). Relative area is a fraction of total surface area; thresholds are ORed. Candidate planes are discovery; only an asserted plane gates symmetry. Approximate sampled tessellation, not exact BREP proof. - 'fastener-installation' — measured explicit catalog-screw installation stations on lowered assembly BREP ({ file | code, fasteners:[{ part, against, engagementPart?, minEngagementMm?, maxProtrusionMm? }], toleranceMm?, angleToleranceDeg? }). Reports annular bearing gap, bore axis/diameter/overlap and receiver geometric engagement/protrusion. Unknown or zero coverage cannot pass. Simplified threads do not certify torque, preload or strength. - 'mounting-holes' — fastened mates: hole pairs one screw can use (equal, or clearance over a tap drill / hole({ thread }) of the same metric size; hole-free faces are a rigid bond) and fastener holes meeting at the contact face are coaxial. Sides it cannot resolve are info, never mismatches. - 'load-capacity' — will it hold? Closed-form Euler-Bernoulli beam check ({ loads, materials, ... }), or mode:'fea' to solve the script's feaStudy (quadratic-tet FEA, CalculiX) — both return { ok, safetyFactor, elements[{ partName, stressPa, yieldPa, safetyFactor }], failures[], diagnostics }; fea adds the threshold, the stress regions as @kc[...] faces with their location, and fea { peakStressPa, maxDisplacementMm, meshTrusted, peakAtSupportPa, refinement }; it refines the mesh automatically until the stress is trusted (refine: false for one solve). - 'static-hold' — gravitational holding torque/force at a sampled pose grid vs each actuated joint's declared actuator capacity ({ joint?, pose?, gravity?, min_torque_margin_pct?, range_samples? }). - 'motion-load' — loads on each driven joint (mechanicalJoint on a revolute mate) while the model moves: gravity, inertia from the animationView tracks (finite differences), optional external forces. Mass and inertia come from the solids and density/material, or a part's massKg. Returns per joint peak torque vs the mechanicalJoint torqueNm (margin; < 1x error, < 2x warning), axial / radial force and bending moment on the actuator shaft (checked only against radialLimitN / axialLimitN; without them 'no rating, not checked'), the radial load on each of up to two coaxial supports (each at its station on the shaft: the actuator at the joint origin, else the support's connector on the axis, else the middle of its material nearest the shaft; an ambiguous station is a mechanism.load.not-resolved warning, not a number), the worst pose and a torque-vs-time series ({ file | code, motion_mode?: 'tracks'|'range', sample_ms?, range_samples?, quasi_static?, gravity?, motion_loads?: [{ part, point, force, fromMs?, toMs? }], supports?: { joint: [parts] }, series_points? }). Pass supports to compare with and without a bushing. Rigid bodies, tree mate graphs, no friction. - 'body-likeness' — publish gate for organic/car bodies: cheap AABB↔wheel checks plus required agent still verdicts (side-body-over-wheels, side-cabin-aft, rear-haunch, ortho-proportions-vs-reference). Pass { body_bbox | code/file+body_feature_id, wheels?, cabin_bbox?, still_verdicts?, require_stills? }. Full CV silhouette matching is NOT implemented — agents must inspect ortho PNGs/Studio and supply still_verdicts before claiming success. - 'edge-radius' — general edge-break specification on final BREP ({ file | code, min_radius_mm?, max_radius_mm?, require_edge_break?: 'external'|'internal'|'all', feature_id?, assembly?, parts?, edges?, faces? }). Reports sharp convex/concave edges, analytic cylindrical/toroidal fillet radii and spherical junctions, and heuristic planar chamfer strips. Radius bounds apply only to fillets; selectors/points are part-local. Unknown/empty coverage cannot pass. All params except `check` are check-specific and forwarded verbatim; each check fails closed on its own missing required params.
Use this when you need to trace why a feature failed. Walk the upstream chain of a failing feature. Returns the diagnostics of the requested feature plus the diagnostics of every upstream feature in topological order (the requested feature is the last entry). Per-code hints are inline on every diagnostic — call lookup_diagnostics for the full catalogue. Pass { file?, code?, feature_id? }.
| Argument | Type | Description |
|---|---|---|
| code | string | |
| file | string | Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| feature_id | string |
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"file": {
"type": "string",
"description": "Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"feature_id": {
"type": "string"
}
}
}Use this when you need to merge a LabWired handoff BOM with optional KernelCAD catalog parts, MPNs and pricing, then write CSV or retrieve Sheets-ready rows. Pass exactly one of handoff, handoff_json or handoff_path. This tool only writes a CSV locally; it makes no Google API calls. Returns headers, tabular rows, CSV contents and the CSV path.
| Argument | Type | Description |
|---|---|---|
| handoff | object | Handoff object with a parts array. |
| overwrite | boolean | Set true to replace an existing CSV destination. Existing files are otherwise preserved. |
| output_path | string | Optional CSV destination. Defaults to artifacts/bom/bom-<id>.csv. |
| handoff_json | string | Handoff JSON text. |
| handoff_path | string | Path to handoff JSON. |
| catalog_parts | array | Optional matching KernelCAD catalog entries with id/ref, partNumber, vendor and price. |
{
"type": "object",
"properties": {
"handoff": {
"type": "object",
"description": "Handoff object with a parts array."
},
"overwrite": {
"type": "boolean",
"description": "Set true to replace an existing CSV destination. Existing files are otherwise preserved."
},
"output_path": {
"type": "string",
"description": "Optional CSV destination. Defaults to artifacts/bom/bom-<id>.csv."
},
"handoff_json": {
"type": "string",
"description": "Handoff JSON text."
},
"handoff_path": {
"type": "string",
"description": "Path to handoff JSON."
},
"catalog_parts": {
"type": "array",
"items": {
"type": "object"
},
"description": "Optional matching KernelCAD catalog entries with id/ref, partNumber, vendor and price."
}
}
}| closed |
| boolean |
| kind:'nurbs' — optional periodic/closed-curve flag. |
| degree | integer | kind:'nurbs' — curve degree; default 3 (cubic). |
| weights | array | kind:'nurbs' — optional rational weights, one per control point (same length as controlPoints). |
| binding_name | string | JS const name for the new Curve3D binding (default: _curve_<N>). |
| controlPoints | array | kind:'nurbs' — control points as Vec3 triples in mm; at least 2 entries. |
{
"type": "object",
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "nurbs"
}
}
},
"then": {
"required": [
"controlPoints"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "hermite"
}
}
},
"then": {
"required": [
"a",
"b"
]
}
}
],
"required": [
"kind",
"code"
],
"properties": {
"a": {
"type": "object",
"required": [
"point",
"tangent"
],
"properties": {
"point": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Endpoint position in mm."
},
"tangent": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "First derivative of the curve at this endpoint."
},
"curvature": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Optional second derivative; defaults to [0, 0, 0] (G1-only)."
}
},
"description": "kind:'hermite' — start endpoint."
},
"b": {
"type": "object",
"required": [
"point",
"tangent"
],
"properties": {
"point": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Endpoint position in mm."
},
"tangent": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "First derivative of the curve at this endpoint."
},
"curvature": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Optional second derivative; defaults to [0, 0, 0] (G1-only)."
}
},
"description": "kind:'hermite' — end endpoint."
},
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"kind": {
"enum": [
"nurbs",
"hermite"
],
"type": "string",
"description": "Which curve-construction path to use."
},
"knots": {
"type": "array",
"items": {
"type": "number"
},
"description": "kind:'nurbs' — optional explicit knot vector; missing => clamped-uniform inferred."
},
"closed": {
"type": "boolean",
"description": "kind:'nurbs' — optional periodic/closed-curve flag."
},
"degree": {
"type": "integer",
"minimum": 1,
"description": "kind:'nurbs' — curve degree; default 3 (cubic)."
},
"weights": {
"type": "array",
"items": {
"type": "number"
},
"description": "kind:'nurbs' — optional rational weights, one per control point (same length as controlPoints)."
},
"binding_name": {
"type": "string",
"description": "JS const name for the new Curve3D binding (default: _curve_<N>)."
},
"controlPoints": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"description": "kind:'nurbs' — control points as Vec3 triples in mm; at least 2 entries."
}
}
}| input | string | relation:'transmission' — optional input. |
| notes | string | relation:'transmission' — optional notes. |
| ratio | number | relation:'coupling' — driven pose = source pose * ratio + offset. |
| driven | string | relation:'coupling' — driven mate name. |
| offset | number | relation:'coupling' — optional pose offset. |
| output | string | relation:'transmission' — optional output. |
| source | string | relation:'coupling' — source mate name. |
| actuator | string | relation:'transmission' — optional actuator. |
| limitsMm | array | relation:'mate' — optional [minMm, maxMm]. |
| relation | string | Which relationship to author (default 'mate'). |
| limitsDeg | array | relation:'mate' — optional [minDeg, maxDeg]. |
| sourceMate | string | relation:'transmission' — source mate name. |
| drivenMates | array | relation:'transmission' — driven mate names. |
| assembly_binding* | string | JS identifier bound to assembly(...). |
{
"type": "object",
"allOf": [
{
"if": {
"anyOf": [
{
"not": {
"required": [
"relation"
]
}
},
{
"required": [
"relation"
],
"properties": {
"relation": {
"const": "mate"
}
}
}
]
},
"then": {
"required": [
"name",
"a",
"b",
"type"
]
}
},
{
"if": {
"required": [
"relation"
],
"properties": {
"relation": {
"const": "coupling"
}
}
},
"then": {
"required": [
"driven",
"source",
"ratio"
]
}
},
{
"if": {
"required": [
"relation"
],
"properties": {
"relation": {
"const": "transmission"
}
}
},
"then": {
"required": [
"name",
"kind",
"sourceMate",
"drivenMates",
"path"
]
}
}
],
"required": [
"code",
"assembly_binding"
],
"properties": {
"a": {
"type": "string",
"description": "relation:'mate' — connector ref \"<partName>.<connectorName>\"."
},
"b": {
"type": "string",
"description": "relation:'mate' — connector ref \"<partName>.<connectorName>\"."
},
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"kind": {
"enum": [
"direct-horn",
"link-rod",
"four-bar",
"gear-pair",
"belt",
"tendon"
],
"type": "string",
"description": "relation:'transmission' — transmission kind."
},
"name": {
"type": "string",
"description": "relation:'mate'|'transmission' — name unique within the assembly."
},
"path": {
"type": "array",
"items": {
"type": "string"
},
"description": "relation:'transmission' — drive path."
},
"pose": {
"type": "object",
"description": "relation:'mate' — optional mate pose."
},
"type": {
"enum": [
"fastened",
"revolute",
"prismatic",
"cylindrical",
"planar",
"ball",
"pin_slot"
],
"type": "string",
"description": "relation:'mate' — mate type."
},
"input": {
"type": "string",
"description": "relation:'transmission' — optional input."
},
"notes": {
"type": "string",
"description": "relation:'transmission' — optional notes."
},
"ratio": {
"type": "number",
"description": "relation:'coupling' — driven pose = source pose * ratio + offset."
},
"driven": {
"type": "string",
"description": "relation:'coupling' — driven mate name."
},
"offset": {
"type": "number",
"description": "relation:'coupling' — optional pose offset."
},
"output": {
"type": "string",
"description": "relation:'transmission' — optional output."
},
"source": {
"type": "string",
"description": "relation:'coupling' — source mate name."
},
"actuator": {
"type": "string",
"description": "relation:'transmission' — optional actuator."
},
"limitsMm": {
"type": "array",
"items": {
"type": "number"
},
"description": "relation:'mate' — optional [minMm, maxMm]."
},
"relation": {
"enum": [
"mate",
"coupling",
"transmission"
],
"type": "string",
"description": "Which relationship to author (default 'mate')."
},
"limitsDeg": {
"type": "array",
"items": {
"type": "number"
},
"description": "relation:'mate' — optional [minDeg, maxDeg]."
},
"sourceMate": {
"type": "string",
"description": "relation:'transmission' — source mate name."
},
"drivenMates": {
"type": "array",
"items": {
"type": "string"
},
"description": "relation:'transmission' — driven mate names."
},
"assembly_binding": {
"type": "string",
"description": "JS identifier bound to assembly(...)."
}
}
}| string |
| Which path-segment kind to append. |
| knots | array | kind:'nurbs' — optional explicit knot vector; length must equal controlPoints.length + degree + 1. |
| degree | integer | kind:'nurbs' — B-spline degree (default 3). |
| points | array | kind:'spline' — waypoints as Vec2 pairs in mm; at least 2 entries; first must match current pen position. |
| tension | number | kind:'spline' — optional Catmull-Rom-style stiffness; forwarded to the underlying B-spline approximation. |
| weights | array | kind:'nurbs' — optional rational weights (one per control point; strictly positive). |
| endTangent | array | kind:'spline' — optional [x, y] direction vector at points[N-1]. Magnitude is normalised internally; direction matters. |
| binding_name | string | Reserved for future use; the segment injection mutates the chain anchor in place. |
| chain_anchor* | string | JS identifier of an existing PathBuilder binding (e.g. `const brow = path().moveTo(0,0)`). |
| startTangent | array | kind:'spline' — optional [x, y] direction vector at points[0]. Magnitude is normalised internally; direction matters. |
| controlPoints | array | kind:'nurbs' — control-net vertices as Vec2 pairs in mm; at least degree+1 entries. |
{
"type": "object",
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "spline"
}
}
},
"then": {
"required": [
"points"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "nurbs"
}
}
},
"then": {
"required": [
"controlPoints"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "hermite"
}
}
},
"then": {
"required": [
"a",
"b"
]
}
}
],
"required": [
"kind",
"code",
"chain_anchor"
],
"properties": {
"a": {
"type": "object",
"required": [
"point",
"tangent"
],
"properties": {
"point": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "Endpoint position in mm."
},
"tangent": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "First derivative (~ chord length), NOT unit length."
},
"curvature": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "Optional second derivative; defaults to [0, 0] (G1-only)."
}
},
"description": "kind:'hermite' — start endpoint; point must match current pen position within 1e-6 mm."
},
"b": {
"type": "object",
"required": [
"point",
"tangent"
],
"properties": {
"point": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "Endpoint position in mm."
},
"tangent": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "First derivative (~ chord length), NOT unit length."
},
"curvature": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "Optional second derivative; defaults to [0, 0] (G1-only)."
}
},
"description": "kind:'hermite' — end endpoint; pen ends at b.point."
},
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"kind": {
"enum": [
"spline",
"nurbs",
"hermite"
],
"type": "string",
"description": "Which path-segment kind to append."
},
"knots": {
"type": "array",
"items": {
"type": "number"
},
"description": "kind:'nurbs' — optional explicit knot vector; length must equal controlPoints.length + degree + 1."
},
"degree": {
"type": "integer",
"minimum": 1,
"description": "kind:'nurbs' — B-spline degree (default 3)."
},
"points": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2
},
"minItems": 2,
"description": "kind:'spline' — waypoints as Vec2 pairs in mm; at least 2 entries; first must match current pen position."
},
"tension": {
"type": "number",
"description": "kind:'spline' — optional Catmull-Rom-style stiffness; forwarded to the underlying B-spline approximation."
},
"weights": {
"type": "array",
"items": {
"type": "number"
},
"description": "kind:'nurbs' — optional rational weights (one per control point; strictly positive)."
},
"endTangent": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "kind:'spline' — optional [x, y] direction vector at points[N-1]. Magnitude is normalised internally; direction matters."
},
"binding_name": {
"type": "string",
"description": "Reserved for future use; the segment injection mutates the chain anchor in place."
},
"chain_anchor": {
"type": "string",
"description": "JS identifier of an existing PathBuilder binding (e.g. `const brow = path().moveTo(0,0)`)."
},
"startTangent": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "kind:'spline' — optional [x, y] direction vector at points[0]. Magnitude is normalised internally; direction matters."
},
"controlPoints": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2
},
"description": "kind:'nurbs' — control-net vertices as Vec2 pairs in mm; at least degree+1 entries."
}
}
}{
"type": "object",
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "linear"
}
}
},
"then": {
"required": [
"linear"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "circular"
}
}
},
"then": {
"required": [
"circular"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "grid"
}
}
},
"then": {
"required": [
"grid"
]
}
}
],
"required": [
"code",
"target",
"kind"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"grid": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "object",
"required": [
"count",
"direction",
"spacing"
],
"properties": {
"count": {
"type": "integer",
"minimum": 2
},
"spacing": {
"type": "number"
},
"direction": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"description": "First grid axis."
},
"y": {
"type": "object",
"required": [
"count",
"direction",
"spacing"
],
"properties": {
"count": {
"type": "integer",
"minimum": 2
},
"spacing": {
"type": "number"
},
"direction": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"description": "Second grid axis."
}
},
"description": "Required when kind=grid."
},
"kind": {
"enum": [
"linear",
"circular",
"grid"
],
"type": "string"
},
"linear": {
"type": "object",
"required": [
"count",
"direction",
"spacing"
],
"properties": {
"count": {
"type": "integer",
"minimum": 2
},
"spacing": {
"type": "number"
},
"direction": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"description": "Required when kind=linear."
},
"target": {
"type": "string",
"description": "Variable name of the Shape to pattern (inserted verbatim as the LHS receiver)."
},
"circular": {
"type": "object",
"required": [
"count",
"axis"
],
"properties": {
"axis": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"count": {
"type": "integer",
"minimum": 2
},
"angleDeg": {
"type": "number",
"description": "Optional; defaults to 360."
}
},
"description": "Required when kind=circular."
},
"assign_to": {
"type": "string",
"description": "Optional const-binding name; emits `const <assign_to> = <target>.patternX(...);`. Omit for statement form."
}
}
}| code* | string | Current .kcad.ts source. |
| face | string | kind:'draft' — face selector for the face(s) to taper. Accepts a canonical name (top/bottom/front/back/left/right), a user label declared via faceLabels, or a FaceQuery descriptor string. |
| kind* | string | Which surface-construction or surface-finishing path to use: 'nurbs' | 'boundary' | 'trim' | 'sew' | 'draft'. |
| knots | object | kind:'nurbs' — optional explicit knot vectors; missing => clamped uniform inferred. |
| degree | object | kind:'nurbs' — degrees in U and V; each in [1, nU-1] / [1, nV-1]. |
| weights | array | kind:'nurbs' — optional rational weights, same grid shape as controls. Ignored in slice-1. |
| controls | array | kind:'nurbs' — control-point grid for direct construction (controls[u][v] = [x, y, z], mm). |
| periodic | object | kind:'nurbs' — optional periodic flags per parametric direction. |
| pull_dir | array | kind:'draft' — demoulding direction as [x, y, z]. Defaults to the face normal at lower time. |
| sampling | integer | kind:'boundary' — points sampled along each boundary (default 15). |
| angle_deg | number | kind:'draft' — draft angle in degrees [0, 90]. The face is tapered outward by this angle relative to the pull direction. |
| tolerance | number | kind:'sew' — edge-merging tolerance in mm (default 1e-6). Edges within this distance are merged. |
| by_binding | string | kind:'trim' — JS variable name of the cutter Surface (must be declared in source). Shape/Curve3D cutters are deferred. |
| continuity | any | kind:'boundary' — continuity grade applied to every edge ('C0' | 'C1' | 'C2'), or an array of 4 grades (one per edge, bottom/right/top/left order). Default 'C0'. |
| binding_name | string | JS const name for the new binding (kind:'nurbs' default surface_<N>; kind:'boundary' default _surface_<N>; kind:'trim' default _trimmed_<N>; kind:'sew' default _sewn_<N>; kind:'draft' default _drafted_<N>). |
| neutral_plane | string | kind:'draft' — parting-line face (the plane where drafted faces remain fixed). Defaults to `face` if omitted. |
| shape_binding | string | kind:'draft' — JS variable name of the Shape to taper (must be declared in source). |
| curve_bindings | array | kind:'boundary' — tuple of 4 existing Curve3D variable names (bottom, right, top, left) declared earlier in the source. |
| require_closed | boolean | kind:'sew' — when true the lowerer emits feature.surface-sew.open-shell if the stitched result is not a watertight solid. |
| surface_binding | string | kind:'trim' — JS variable name of the Surface to trim/split (must be declared in source). |
| surface_bindings | array | kind:'sew' — JS variable names of the surfaces to stitch into a solid (each must be declared in source). |
| section_sketch_ids | array | kind:'nurbs' — existing sketch FeatureIds (2 or more) to skin a surface through, in order. |
{
"type": "object",
"required": [
"kind",
"code"
],
"properties": {
"op": {
"enum": [
"trim",
"split"
],
"type": "string",
"description": "kind:'trim' — 'trim' discards the smaller half (calls .trimTo()); 'split' retains both halves (calls .split())."
},
"code": {
"type": "string",
"description": "Current .kcad.ts source."
},
"face": {
"type": "string",
"description": "kind:'draft' — face selector for the face(s) to taper. Accepts a canonical name (top/bottom/front/back/left/right), a user label declared via faceLabels, or a FaceQuery descriptor string."
},
"kind": {
"enum": [
"nurbs",
"boundary",
"trim",
"sew",
"draft"
],
"type": "string",
"description": "Which surface-construction or surface-finishing path to use: 'nurbs' | 'boundary' | 'trim' | 'sew' | 'draft'."
},
"knots": {
"type": "object",
"properties": {
"u": {
"type": "array",
"items": {
"type": "number"
}
},
"v": {
"type": "array",
"items": {
"type": "number"
}
}
},
"description": "kind:'nurbs' — optional explicit knot vectors; missing => clamped uniform inferred."
},
"degree": {
"type": "object",
"required": [
"u",
"v"
],
"properties": {
"u": {
"type": "integer",
"minimum": 1
},
"v": {
"type": "integer",
"minimum": 1
}
},
"description": "kind:'nurbs' — degrees in U and V; each in [1, nU-1] / [1, nV-1]."
},
"weights": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
},
"description": "kind:'nurbs' — optional rational weights, same grid shape as controls. Ignored in slice-1."
},
"controls": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
},
"description": "kind:'nurbs' — control-point grid for direct construction (controls[u][v] = [x, y, z], mm)."
},
"periodic": {
"type": "object",
"properties": {
"u": {
"type": "boolean"
},
"v": {
"type": "boolean"
}
},
"description": "kind:'nurbs' — optional periodic flags per parametric direction."
},
"pull_dir": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "kind:'draft' — demoulding direction as [x, y, z]. Defaults to the face normal at lower time."
},
"sampling": {
"type": "integer",
"minimum": 1,
"description": "kind:'boundary' — points sampled along each boundary (default 15)."
},
"angle_deg": {
"type": "number",
"maximum": 90,
"minimum": 0,
"description": "kind:'draft' — draft angle in degrees [0, 90]. The face is tapered outward by this angle relative to the pull direction."
},
"tolerance": {
"type": "number",
"description": "kind:'sew' — edge-merging tolerance in mm (default 1e-6). Edges within this distance are merged."
},
"by_binding": {
"type": "string",
"description": "kind:'trim' — JS variable name of the cutter Surface (must be declared in source). Shape/Curve3D cutters are deferred."
},
"continuity": {
"oneOf": [
{
"enum": [
"C0",
"C1",
"C2"
],
"type": "string"
},
{
"type": "array",
"items": {
"enum": [
"C0",
"C1",
"C2"
],
"type": "string"
},
"maxItems": 4,
"minItems": 4
}
],
"description": "kind:'boundary' — continuity grade applied to every edge ('C0' | 'C1' | 'C2'), or an array of 4 grades (one per edge, bottom/right/top/left order). Default 'C0'."
},
"binding_name": {
"type": "string",
"description": "JS const name for the new binding (kind:'nurbs' default surface_<N>; kind:'boundary' default _surface_<N>; kind:'trim' default _trimmed_<N>; kind:'sew' default _sewn_<N>; kind:'draft' default _drafted_<N>)."
},
"neutral_plane": {
"type": "string",
"description": "kind:'draft' — parting-line face (the plane where drafted faces remain fixed). Defaults to `face` if omitted."
},
"shape_binding": {
"type": "string",
"description": "kind:'draft' — JS variable name of the Shape to taper (must be declared in source)."
},
"curve_bindings": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 4,
"description": "kind:'boundary' — tuple of 4 existing Curve3D variable names (bottom, right, top, left) declared earlier in the source."
},
"require_closed": {
"type": "boolean",
"description": "kind:'sew' — when true the lowerer emits feature.surface-sew.open-shell if the stitched result is not a watertight solid."
},
"surface_binding": {
"type": "string",
"description": "kind:'trim' — JS variable name of the Surface to trim/split (must be declared in source)."
},
"surface_bindings": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "kind:'sew' — JS variable names of the surfaces to stitch into a solid (each must be declared in source)."
},
"section_sketch_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "kind:'nurbs' — existing sketch FeatureIds (2 or more) to skin a surface through, in order."
}
}
}| depth | number | mode:'emboss' — signed extrusion depth in mm: positive emboss out, negative engrave in. Must be non-zero. |
| bindAs | string | mode:'sketch' — emits `const <bindAs> = sketch.text(...)`; mode:'emboss' — emits `const <bindAs> = <target>.embossText(...);`. |
| target | string | mode:'emboss' — variable name of the Shape to chain onto (inserted verbatim). |
| anchorU | number | mode:'emboss' — U anchor in [0, 1] face-local (0=umin, 0.5=centre, 1=umax). Default 0.5. |
| anchorV | number | mode:'emboss' — V anchor in [0, 1] face-local. Default 0.5. |
| content | string | mode:'sketch' — text content (UTF-8, non-empty, non-whitespace). |
| position | array | mode:'sketch' — [x, y] anchor in mm. Default [0, 0]. |
| rotation | number | mode:'sketch' — CCW rotation in degrees around position (default 0); mode:'emboss' — CCW rotation in the face tangent plane (default 0). |
| scaleMode | string | mode:'emboss' — Drawing.sketchOnFace scaling mode. Default original. |
| fontFamily | string | mode:'emboss' — optional logical font name or .ttf file path; defaults to bundled Liberation Sans. |
| textContent | string | mode:'emboss' — text content (UTF-8, non-empty, non-whitespace). |
{
"type": "object",
"required": [
"mode",
"code"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"face": {
"type": "string",
"description": "mode:'emboss' — target face — canonical name ('top'/'bottom'/'left'/'right'/'front'/'back') or label."
},
"font": {
"type": "string",
"description": "mode:'sketch' — optional logical font name or .ttf file path; defaults to bundled Liberation Sans."
},
"mode": {
"enum": [
"sketch",
"emboss"
],
"type": "string",
"description": "Which text-authoring path to use."
},
"size": {
"type": "number",
"description": "mode:'sketch'|'emboss' — glyph cap height in mm (positive finite)."
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string",
"description": "mode:'sketch' — horizontal alignment relative to position (default left); mode:'emboss' — relative to the UV anchor (default center)."
},
"depth": {
"type": "number",
"description": "mode:'emboss' — signed extrusion depth in mm: positive emboss out, negative engrave in. Must be non-zero."
},
"bindAs": {
"type": "string",
"description": "mode:'sketch' — emits `const <bindAs> = sketch.text(...)`; mode:'emboss' — emits `const <bindAs> = <target>.embossText(...);`."
},
"target": {
"type": "string",
"description": "mode:'emboss' — variable name of the Shape to chain onto (inserted verbatim)."
},
"anchorU": {
"type": "number",
"description": "mode:'emboss' — U anchor in [0, 1] face-local (0=umin, 0.5=centre, 1=umax). Default 0.5."
},
"anchorV": {
"type": "number",
"description": "mode:'emboss' — V anchor in [0, 1] face-local. Default 0.5."
},
"content": {
"type": "string",
"description": "mode:'sketch' — text content (UTF-8, non-empty, non-whitespace)."
},
"position": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"description": "mode:'sketch' — [x, y] anchor in mm. Default [0, 0]."
},
"rotation": {
"type": "number",
"description": "mode:'sketch' — CCW rotation in degrees around position (default 0); mode:'emboss' — CCW rotation in the face tangent plane (default 0)."
},
"scaleMode": {
"enum": [
"original",
"native",
"bounds"
],
"type": "string",
"description": "mode:'emboss' — Drawing.sketchOnFace scaling mode. Default original."
},
"fontFamily": {
"type": "string",
"description": "mode:'emboss' — optional logical font name or .ttf file path; defaults to bundled Liberation Sans."
},
"textContent": {
"type": "string",
"description": "mode:'emboss' — text content (UTF-8, non-empty, non-whitespace)."
}
}
}| string |
| Inter-section continuity; default 'C1'. |
| binding_name | string | JS const name for the new Shape binding (default: _sweep_<N>). |
| spine_closed | boolean | With spine_points: close the spline into a loop (ring band, loop handle). |
| spine_points | array | Inline spine: at least 2 [x, y, z] points in mm, interpolated with spline3d. Use this OR spine_binding. |
| spine_binding | string | Existing variable name for a Curve3D / Sketch / Vec3[] declared earlier in the source. Use this OR spine_points. |
{
"type": "object",
"required": [
"code",
"sections"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code (\"\" for a new script)."
},
"closed": {
"type": "boolean",
"description": "Optional closed-sweep flag."
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"t": {
"type": "number",
"description": "Spine parameter in [0, 1]."
},
"width": {
"type": "number",
"description": "Inline rectangular profile width, mm (with height)."
},
"height": {
"type": "number",
"description": "Inline rectangular profile height, mm (with width)."
},
"radius": {
"type": "number",
"description": "Inline circular profile radius, mm."
},
"profile_binding": {
"type": "string",
"description": "Existing Sketch variable name for this section (instead of radius / width+height)."
}
}
},
"description": "Varying cross-sections along the spine; at least 2 entries, strictly increasing in `t`, first t=0, last t=1."
},
"continuity": {
"enum": [
"C0",
"C1",
"C2"
],
"type": "string",
"description": "Inter-section continuity; default 'C1'."
},
"binding_name": {
"type": "string",
"description": "JS const name for the new Shape binding (default: _sweep_<N>)."
},
"spine_closed": {
"type": "boolean",
"description": "With spine_points: close the spline into a loop (ring band, loop handle)."
},
"spine_points": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"description": "Inline spine: at least 2 [x, y, z] points in mm, interpolated with spline3d. Use this OR spine_binding."
},
"spine_binding": {
"type": "string",
"description": "Existing variable name for a Curve3D / Sketch / Vec3[] declared earlier in the source. Use this OR spine_points."
}
}
}| Existing Shape variable name to blend. |
{
"type": "object",
"required": [
"code",
"shape_binding"
],
"properties": {
"code": {
"type": "string",
"description": "Inline .kcad.ts source."
},
"radius": {
"type": "number",
"description": "Fillet radius in mm; required for operation:'fillet'.",
"exclusiveMinimum": 0
},
"distance": {
"type": "number",
"description": "Chamfer distance in mm; required for operation:'chamfer'.",
"exclusiveMinimum": 0
},
"selector": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"required": [
"face"
],
"properties": {
"face": {
"type": "string"
}
},
"additionalProperties": false
}
],
"description": "Optional EdgeSelector: a canonical @kc[...] edge ref/query string or { face: canonical face name, face label, or FaceQuery descriptor }. Omit to select all sharp edges."
},
"operation": {
"enum": [
"fillet",
"chamfer"
],
"type": "string",
"description": "Operation; defaults to 'fillet'."
},
"continuity": {
"enum": [
"G1",
"G2"
],
"type": "string",
"description": "Fillet continuity passed to the existing public API; defaults to G1. Chamfer ignores this field."
},
"shape_binding": {
"type": "string",
"description": "Existing Shape variable name to blend."
}
}
}| Argument |
|---|
| Type |
|---|
| Description |
|---|
| fps | number | Override the animationView record's fps. |
| file* | string | Path to a .kcad.ts script with an animationView({...}) record (any script in turntable mode). Required (no inline { code } mode). Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| hide | array | Hide matching feature ids / assembly part names in the rendered frames. Mutually exclusive with focus. Render-only; does not affect pose verification. |
| focus | array | Show only matching feature ids / assembly part names in the rendered frames. Mutually exclusive with hide. Render-only; does not affect pose verification. |
| width | integer | Turntable frame width in px (default 1080; even for MP4). |
| height | integer | Turntable frame height in px (default 1080; even for MP4). |
| preset | string | Turntable look: 'publish' (default; studio product shot) or 'default' (engineering look). |
| shadow | boolean | Turntable + publish: soft contact shadow under the model (default true). |
| no_verify | boolean | Skip the animation-pose interference verification (default: verify on). |
| turntable | boolean | Seamless 360° orbit of the model instead of the animationView timeline. |
| background | string | Turntable + publish: 'white' (default), 'light', 'dark', 'black', '#rrggbb', or 'transparent' (frames_dir only — MP4/GIF have no usable alpha). |
| frames_dir | string | PNG-sequence mode directory: write frame-0000.png... and skip ffmpeg. Mutually exclusive with output_path. |
| duration_ms | number | Turntable: one full revolution in ms (default 6000). |
| environment | string | Turntable: HDRI environment override ('studio', 'softbox', 'neutral', 'outdoor', 'warehouse', a URL, or 'none'). |
| output_path | string | MP4 output path (.gif → looping GIF); default <scriptDir>/<basename>-animation.mp4 (-turntable.mp4 in turntable mode). Mutually exclusive with frames_dir. |
| verify_every | integer | Additionally verify at every n-th frame time of the fps schedule (unioned with the keyframe sample set). |
| elevation_deg | number | Turntable: camera elevation above the horizon in degrees (default 22). |
{
"type": "object",
"required": [
"file"
],
"properties": {
"fps": {
"type": "number",
"description": "Override the animationView record's fps."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script with an animationView({...}) record (any script in turntable mode). Required (no inline { code } mode). Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"hide": {
"type": "array",
"items": {
"type": "string"
},
"description": "Hide matching feature ids / assembly part names in the rendered frames. Mutually exclusive with focus. Render-only; does not affect pose verification."
},
"focus": {
"type": "array",
"items": {
"type": "string"
},
"description": "Show only matching feature ids / assembly part names in the rendered frames. Mutually exclusive with hide. Render-only; does not affect pose verification."
},
"width": {
"type": "integer",
"maximum": 2048,
"minimum": 64,
"description": "Turntable frame width in px (default 1080; even for MP4)."
},
"height": {
"type": "integer",
"maximum": 2048,
"minimum": 64,
"description": "Turntable frame height in px (default 1080; even for MP4)."
},
"preset": {
"enum": [
"default",
"publish"
],
"type": "string",
"description": "Turntable look: 'publish' (default; studio product shot) or 'default' (engineering look)."
},
"shadow": {
"type": "boolean",
"description": "Turntable + publish: soft contact shadow under the model (default true)."
},
"no_verify": {
"type": "boolean",
"default": false,
"description": "Skip the animation-pose interference verification (default: verify on)."
},
"turntable": {
"type": "boolean",
"default": false,
"description": "Seamless 360° orbit of the model instead of the animationView timeline."
},
"background": {
"type": "string",
"description": "Turntable + publish: 'white' (default), 'light', 'dark', 'black', '#rrggbb', or 'transparent' (frames_dir only — MP4/GIF have no usable alpha)."
},
"frames_dir": {
"type": "string",
"description": "PNG-sequence mode directory: write frame-0000.png... and skip ffmpeg. Mutually exclusive with output_path."
},
"duration_ms": {
"type": "number",
"maximum": 60000,
"minimum": 500,
"description": "Turntable: one full revolution in ms (default 6000)."
},
"environment": {
"type": "string",
"description": "Turntable: HDRI environment override ('studio', 'softbox', 'neutral', 'outdoor', 'warehouse', a URL, or 'none')."
},
"output_path": {
"type": "string",
"description": "MP4 output path (.gif → looping GIF); default <scriptDir>/<basename>-animation.mp4 (-turntable.mp4 in turntable mode). Mutually exclusive with frames_dir."
},
"verify_every": {
"type": "integer",
"minimum": 1,
"description": "Additionally verify at every n-th frame time of the fps schedule (unioned with the keyframe sample set)."
},
"elevation_deg": {
"type": "number",
"maximum": 89,
"minimum": -89,
"description": "Turntable: camera elevation above the horizon in degrees (default 22)."
}
}
}| autoRevise | boolean | When true (default), failing attempts with repairable feature diagnostics (boolean miss, oversized fillet, …) run bounded repair_script and attach revisionAssist.suggestedPatches / autoApplied.suggestedCode. Set false to skip the extra repair pass (hints-only). Does not autonomously rewrite full CAD models. |
| epsilonMm3 | number | Forwarded to review_cad. |
| stopOnPass | boolean | Stop after the first attempt that is functional and passes the quality gate. Default true. |
| recordTitle | string | Optional title for the build record. |
| bodyLikeness | object | When likenessProfile=automotive: body_bbox (required for gate), wheels, cabin_bbox, still_verdicts. Missing body_bbox fails with reference.likeness.gate-required. Stills may also come from visualReview.checks. |
| combinatorial | boolean | Sample all 2^N limit-corner combinations across mates with declared limits. Capped at 8 mates with limits; combine with samplesPerMate for both interior coverage and worst-pose detection. Default false. |
| samplesPerMate | integer | Pose-envelope samples per declared-limit mate. 1 (default) = corners only; >=3 adds uniform interior points between min and max. Total samples per non-locked mate = samplesPerMate. |
| gripperAperture | object | Optional gripper aperture request forwarded to review_cad. |
| likenessProfile | string | When 'automotive', require organic-body still checks on visualReview AND the body-likeness publish gate (pass bodyLikeness or stills on checks). Attempts stay non-ok until publishReady. Final open_in_studio must pass likeness_profile:'automotive' (server hard-gates success). |
| trackConnectors | array | Connector refs to track across sampled poses. |
| outputRecordPath | string | Optional JSON path to write a Studio-compatible build record. |
| preserveInterfaces | array | External mates, connector refs, part names, or behavioral interfaces the agent must preserve between attempts. |
| allowReviewWarnings | array | Warning diagnostic codes the original prompt explicitly allows. Other review warnings keep the loop iterating even if review_cad is functionally ok. |
| includeInterference | boolean | Forwarded to review_cad. Default true. |
| includePoseEnvelope | boolean | Forwarded to review_cad. Default true. |
| requireVisualReview | boolean | Require screenshot-backed visualReview with structured checks before accepting an attempt. Default true; set false only for explicit non-visual batch checks. |
| requirePhysicalAcceptance | boolean | Require declared physicalUseCase common-pose reachability and pose-bound quasi-static certification before accepting an attempt. Design-loop also enables this automatically when an attempt script calls physicalUseCase(...). |
{
"type": "object",
"required": [
"goal",
"attempts"
],
"properties": {
"goal": {
"type": "string",
"description": "Original user design goal. Fed into every review_cad repair prompt."
},
"assembly": {
"type": "string"
},
"attempts": {
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"required": [
"file"
]
},
{
"required": [
"code"
]
}
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string",
"description": "Inline kernelCAD script source. Provide file or code."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script on disk. Provide file or code."
},
"title": {
"type": "string"
},
"visualReview": {
"type": "object",
"required": [
"accepted",
"findings"
],
"properties": {
"checks": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"passed",
"finding"
],
"properties": {
"code": {
"type": "string"
},
"passed": {
"type": "boolean"
},
"finding": {
"type": "string"
},
"screenshotPath": {
"type": "string"
}
}
},
"description": "Required checklist entries: main-object-count, proportions-match-reference, required-visible-features, no-stray-or-floating-geometry, attachment-plausibility, semantic-orientation-alignment, device-depth-and-construction, canonical-views-physically-coherent."
},
"accepted": {
"type": "boolean"
},
"findings": {
"type": "array",
"items": {
"type": "string"
}
},
"screenshotPath": {
"type": "string"
}
},
"description": "Optional. Evidence from the reviewing agent after rendering/opening screenshots. Accepted reviews must include screenshotPath, concrete findings, and all required checks passing."
}
}
},
"description": "Ordered design attempts. Each item is { id?, title?, file? OR code?, visualReview? } — provide file or code (at least one). File attempts can be replayed by Studio build records."
},
"consensus": {
"type": "boolean",
"description": "Best-of-N by geometric consensus. When true, attempts are N independent candidates for the SAME goal (not a repair sequence): all are reviewed (stopOnPass ignored), all scripts are executed, candidates without a valid solid are dropped, and the candidate whose geometry agrees most with the others (medoid by symmetric Chamfer distance, same model frame) is selected. Ties go to more gates passed, then the shorter script. Returns consensus { chosenIndex, chosenAttemptId, scores, distances, reason }; ok / finalAttemptId / nextActionPrompt describe the selected candidate. Default false."
},
"autoRevise": {
"type": "boolean",
"description": "When true (default), failing attempts with repairable feature diagnostics (boolean miss, oversized fillet, …) run bounded repair_script and attach revisionAssist.suggestedPatches / autoApplied.suggestedCode. Set false to skip the extra repair pass (hints-only). Does not autonomously rewrite full CAD models."
},
"epsilonMm3": {
"type": "number",
"description": "Forwarded to review_cad."
},
"stopOnPass": {
"type": "boolean",
"description": "Stop after the first attempt that is functional and passes the quality gate. Default true."
},
"recordTitle": {
"type": "string",
"description": "Optional title for the build record."
},
"bodyLikeness": {
"type": "object",
"properties": {
"wheels": {
"type": "array",
"items": {
"type": "object"
}
},
"body_bbox": {
"type": "object"
},
"cabin_bbox": {
"type": "object"
},
"length_axis": {
"enum": [
"x",
"y"
],
"type": "string"
},
"require_stills": {
"type": "boolean"
},
"still_verdicts": {
"type": "array",
"items": {
"type": "object"
}
}
},
"description": "When likenessProfile=automotive: body_bbox (required for gate), wheels, cabin_bbox, still_verdicts. Missing body_bbox fails with reference.likeness.gate-required. Stills may also come from visualReview.checks."
},
"combinatorial": {
"type": "boolean",
"description": "Sample all 2^N limit-corner combinations across mates with declared limits. Capped at 8 mates with limits; combine with samplesPerMate for both interior coverage and worst-pose detection. Default false."
},
"samplesPerMate": {
"type": "integer",
"minimum": 1,
"description": "Pose-envelope samples per declared-limit mate. 1 (default) = corners only; >=3 adds uniform interior points between min and max. Total samples per non-locked mate = samplesPerMate."
},
"gripperAperture": {
"type": "object",
"description": "Optional gripper aperture request forwarded to review_cad."
},
"likenessProfile": {
"enum": [
"automotive"
],
"type": "string",
"description": "When 'automotive', require organic-body still checks on visualReview AND the body-likeness publish gate (pass bodyLikeness or stills on checks). Attempts stay non-ok until publishReady. Final open_in_studio must pass likeness_profile:'automotive' (server hard-gates success)."
},
"trackConnectors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Connector refs to track across sampled poses."
},
"outputRecordPath": {
"type": "string",
"description": "Optional JSON path to write a Studio-compatible build record."
},
"preserveInterfaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "External mates, connector refs, part names, or behavioral interfaces the agent must preserve between attempts."
},
"allowReviewWarnings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Warning diagnostic codes the original prompt explicitly allows. Other review warnings keep the loop iterating even if review_cad is functionally ok."
},
"includeInterference": {
"type": "boolean",
"description": "Forwarded to review_cad. Default true."
},
"includePoseEnvelope": {
"type": "boolean",
"description": "Forwarded to review_cad. Default true."
},
"requireVisualReview": {
"type": "boolean",
"description": "Require screenshot-backed visualReview with structured checks before accepting an attempt. Default true; set false only for explicit non-visual batch checks."
},
"requirePhysicalAcceptance": {
"type": "boolean",
"description": "Require declared physicalUseCase common-pose reachability and pose-bound quasi-static certification before accepting an attempt. Design-loop also enables this automatically when an attempt script calls physicalUseCase(...)."
}
}
}| processes |
| array |
| Processes to review. Default ['fdm', 'cnc']. |
| approach_axes | array | CNC tool approach directions, one per setup (the tool comes from that side). Default ['+z']. |
| max_bridge_mm | number | FDM longest unsupported bridge, mm. Default 10. |
| build_direction | string | FDM part-local axis pointing up from the bed. Default '+z'. |
| max_overhang_deg | number | FDM steepest printable overhang, degrees from vertical (0 = wall, 90 = flat ceiling). Default 45. |
| tool_diameter_mm | number | CNC end-mill diameter, mm. Default 6. |
| max_undercut_area_mm2 | number | CNC unreachable area tolerated before cnc.undercuts fails, mm². Default 1. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"printer": {
"enum": [
"generic-fdm",
"bambu-a1-mini",
"bambu-a1",
"bambu-p1s",
"bambu-p1p",
"bambu-x1c",
"bambu-x1e",
"bambu-h2d",
"bambu-h2s",
"prusa-mini-plus",
"prusa-mk4s",
"prusa-core-one",
"prusa-xl",
"creality-ender-3-v3",
"creality-k1",
"creality-k1-max",
"creality-k2-plus",
"elegoo-neptune-4-pro",
"anycubic-kobra-3",
"voron-2.4-250",
"voron-2.4-300",
"voron-2.4-350",
"ultimaker-s5"
],
"type": "string",
"description": "FDM printer profile id for the bed-fit check. Default 'generic-fdm'."
},
"nozzle_mm": {
"type": "number",
"description": "FDM nozzle diameter, mm. Default 0.4."
},
"processes": {
"type": "array",
"items": {
"enum": [
"fdm",
"cnc"
],
"type": "string"
},
"description": "Processes to review. Default ['fdm', 'cnc']."
},
"approach_axes": {
"type": "array",
"items": {
"enum": [
"+x",
"-x",
"+y",
"-y",
"+z",
"-z"
],
"type": "string"
},
"description": "CNC tool approach directions, one per setup (the tool comes from that side). Default ['+z']."
},
"max_bridge_mm": {
"type": "number",
"description": "FDM longest unsupported bridge, mm. Default 10."
},
"build_direction": {
"enum": [
"+x",
"-x",
"+y",
"-y",
"+z",
"-z"
],
"type": "string",
"description": "FDM part-local axis pointing up from the bed. Default '+z'."
},
"max_overhang_deg": {
"type": "number",
"description": "FDM steepest printable overhang, degrees from vertical (0 = wall, 90 = flat ceiling). Default 45."
},
"tool_diameter_mm": {
"type": "number",
"description": "CNC end-mill diameter, mm. Default 6."
},
"max_undercut_area_mm2": {
"type": "number",
"description": "CNC unreachable area tolerated before cnc.undercuts fails, mm². Default 1."
}
}
}| params | object | Param-override mode: re-lower the BASELINE with these declared param() values changed (e.g. { plateThickness: 8 }). Mutually exclusive with file/code. A name the baseline does not declare fails with the declared-param list in the message. |
| render | boolean | Also render an overlay PNG — added material green, removed material red — via the render_preview pipeline. Off by default; the numeric table is the agent-facing evidence. |
| out_dir | string | Directory for the overlay PNG, its STL inputs, and the generated overlay script. Default: a temp dir. |
| baseCode | string | Baseline script — inline source. |
| baseFile | string | Baseline script — path to a .kcad.ts file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Revised script — inline source. Mutually exclusive with params."
},
"file": {
"type": "string",
"description": "Revised script — path to a .kcad.ts file. Mutually exclusive with params. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"params": {
"type": "object",
"description": "Param-override mode: re-lower the BASELINE with these declared param() values changed (e.g. { plateThickness: 8 }). Mutually exclusive with file/code. A name the baseline does not declare fails with the declared-param list in the message.",
"additionalProperties": true
},
"render": {
"type": "boolean",
"description": "Also render an overlay PNG — added material green, removed material red — via the render_preview pipeline. Off by default; the numeric table is the agent-facing evidence."
},
"out_dir": {
"type": "string",
"description": "Directory for the overlay PNG, its STL inputs, and the generated overlay script. Default: a temp dir."
},
"baseCode": {
"type": "string",
"description": "Baseline script — inline source."
},
"baseFile": {
"type": "string",
"description": "Baseline script — path to a .kcad.ts file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
}
}
}{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Revised (after) script — inline source. One of file / code is required."
},
"file": {
"type": "string",
"description": "Revised (after) script — path to a .kcad.ts file. Local servers only. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"baseCode": {
"type": "string",
"description": "Baseline (before) script — inline source. One of baseFile / baseCode is required."
},
"baseFile": {
"type": "string",
"description": "Baseline (before) script — path to a .kcad.ts file. Local servers only. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
}
}
}| Path to the drawing PDF on the machine running kernelCAD. Hosted server: pass an https:// URL, a data: URI, or "asset:<id>" from request_upload — not a path on your machine. |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| verify | boolean | Evaluate the rebuilt part and compare it with the drawing. Default true. |
| pdfBase64 | string | The PDF inline, base64-encoded. Use this instead of `path` against a hosted kernelCAD server. |
| projection | string | Override the projection angle read from the sheet (default: projection symbol or note, else third-angle). |
{
"type": "object",
"properties": {
"out": {
"type": "string",
"description": "Write the emitted script here (a .kcad.ts path); the ledger is written beside it as <stem>.ledger.json."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "1-based page to read. Default 1."
},
"path": {
"type": "string",
"description": "Path to the drawing PDF on the machine running kernelCAD. Hosted server: pass an https:// URL, a data: URI, or \"asset:<id>\" from request_upload — not a path on your machine."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"verify": {
"type": "boolean",
"description": "Evaluate the rebuilt part and compare it with the drawing. Default true."
},
"pdfBase64": {
"type": "string",
"description": "The PDF inline, base64-encoded. Use this instead of `path` against a hosted kernelCAD server."
},
"projection": {
"enum": [
"third-angle",
"first-angle"
],
"type": "string",
"description": "Override the projection angle read from the sheet (default: projection symbol or note, else third-angle)."
}
}
}| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| dryRun | boolean | Fast validation only: skip solid build, DFM gates, and meshing. Does not set or clear the active session. |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| kernel | string | Solid-modeling kernel. Default 'occt' (OpenCascade); opt-in 'smlib' uses guarded candidates with explicit OCCT fallback diagnostics. |
| skipMechanismCheck | boolean | Opt out of the default mechanism-truth gate. By default a full evaluation of an assembly-built scene runs checkMechanismTruth and returns a `mechanism` verdict (real/broken/unverified); a broken mechanism makes ok:false. Set true to skip the sweep entirely (no `mechanism` field, no cost). Ignored for dryRun and non-assembly scripts. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"dryRun": {
"type": "boolean",
"description": "Fast validation only: skip solid build, DFM gates, and meshing. Does not set or clear the active session."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"kernel": {
"enum": [
"occt",
"smlib"
],
"type": "string",
"description": "Solid-modeling kernel. Default 'occt' (OpenCascade); opt-in 'smlib' uses guarded candidates with explicit OCCT fallback diagnostics."
},
"skipMechanismCheck": {
"type": "boolean",
"description": "Opt out of the default mechanism-truth gate. By default a full evaluation of an assembly-built scene runs checkMechanismTruth and returns a `mechanism` verdict (real/broken/unverified); a broken mechanism makes ok:false. Set true to skip the sweep entirely (no `mechanism` field, no cost). Ignored for dryRun and non-assembly scripts."
}
}
}| project | string | Slug of an existing project. Adds a revision to that project. Omit to start a new project when this cookbook or design is different from the one this chat already saved. |
| new_project | boolean | Pass true to start a separate project even when this cookbook was already published in this chat. |
| openInStudio | boolean | Default false. When true, after a green full (non-dryRun) evaluate, call open_in_studio on the same script (hosted MCP). |
| continue_design | boolean | Pass true to add a revision to the design this chat is already saving, even if this call runs a different cookbook. Ignored when `project` is set. |
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Cookbook snippet id (e.g. gt2-timing-belt-drive, extrude-rounded-rect-plate)."
},
"query": {
"type": "string",
"description": "When id is omitted: natural-language query; BM25 picks the top hit (same as lookup_cookbook)."
},
"dryRun": {
"type": "boolean",
"default": false,
"description": "Default false. dryRun:true is NOT evidence the cookbook builds a solid — capture-only checks; do not claim success or open Studio from a dry run alone."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"kernel": {
"enum": [
"occt",
"smlib"
],
"type": "string",
"description": "Solid-modeling kernel forwarded to evaluate_script. Default 'occt'; opt-in 'smlib' uses guarded candidates with explicit OCCT fallback diagnostics."
},
"project": {
"type": "string",
"minLength": 1,
"description": "Slug of an existing project. Adds a revision to that project. Omit to start a new project when this cookbook or design is different from the one this chat already saved."
},
"new_project": {
"type": "boolean",
"description": "Pass true to start a separate project even when this cookbook was already published in this chat."
},
"openInStudio": {
"type": "boolean",
"default": false,
"description": "Default false. When true, after a green full (non-dryRun) evaluate, call open_in_studio on the same script (hosted MCP)."
},
"continue_design": {
"type": "boolean",
"description": "Pass true to add a revision to the design this chat is already saving, even if this call runs a different cookbook. Ignored when `project` is set."
}
}
}| assembly_order | array |
{
"type": "object",
"properties": {
"axis": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Assembly direction; default +Z."
},
"mode": {
"enum": [
"axis",
"radial"
],
"type": "string",
"description": "Explode direction strategy; default axis."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"center",
"size"
],
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"center": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"additionalProperties": false
},
"description": "Named assembly parts and measured bbox centers/sizes in mm. Optional when handoff is supplied."
},
"handoff": {
"type": "object",
"description": "Optional handoff metadata. Assembly order lookup supports assembly_order or assembly.order.",
"additionalProperties": true
},
"spacing": {
"type": "number",
"description": "Positive spacing scale; default 1.25."
},
"duration_ms": {
"type": "integer",
"description": "Timeline duration from 500 to 60000 ms; default 3000."
},
"assembly_order": {
"type": "array",
"items": {
"type": "string"
}
}
}
}| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| part | string | target:'part' — part name for single-part export, or 'all'. |
| format | string | target:'model' — output file format (required for that target). |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| target* | string | Which exporter to run: 'model' (whole-script geometry to one file) or 'part' (per-part STLs from a solved assembly). |
| options | object | target:'model' — optional per-format options bag. Discriminator options.format must equal top-level format. dxf: { layers?, unit?: "mm"|"cm"|"in", tolerance?, section?: { axis: "x"|"y"|"z", at: mm }, layout?: "per-part"|"sheet" }. 3mf: { printUnit?: "mm"|"cm"|"in", embedSource?, arrange?: "none"|"plate"|"assembled", orient?: boolean, slicer?: "generic"|"bambu"|"orca"|"prusa", printer?: printer profile id, one of "generic-fdm"|"bambu-a1-mini"|"bambu-a1"|"bambu-p1s"|"bambu-p1p"|"bambu-x1c"|"bambu-x1e"|"bambu-h2d"|"bambu-h2s"|"prusa-mini-plus"|"prusa-mk4s"|"prusa-core-one"|"prusa-xl"|"creality-ender-3-v3"|"creality-k1"|"creality-k1-max"|"creality-k2-plus"|"elegoo-neptune-4-pro"|"anycubic-kobra-3"|"voron-2.4-250"|"voron-2.4-300"|"voron-2.4-350"|"ultimaker-s5" (default "generic-fdm"; sets the bed for arrange and the slicer default; an unknown id is refused with the valid list; CLI: kernelcad print printers) }; parts that do not fit the bed are still written and reported as warn diagnostics export.3mf.plate-overflow / export.3mf.exceeds-bed, whose hint names the smallest profiles the layout fits on. gcode: { printer?: printer profile id, layerHeight?: mm, infill?: percent, supports?: boolean, material?: string }; requires a locally installed OrcaSlicer. Returns slicer predictions as gcode_stats; does not start a printer. glb: { axis?: "y-up"|"z-up", draco?: false }. obj and usd are mesh exports with no extra options; usd writes ASCII USDA (millimeter, Z-up). svg-drawing: { views?: ["front"], sheet?: "a4"|"a3" (or any pdf-drawing sheet), projection?, titleBlock?: { title?, partName?, material?, revision? }, modelName?, date?, annotations?, exploded?: { factor, mode? }, balloons?, partsList?, sections?, autoAnnotate? }. views:["front"] produces a centred front-only elevation for SVG or PDF; omit views for four views. Front-only sheets require front annotations and reject isometric balloons/exploded overlays. svg-drawing annotations is an array of authored dimensions/notes, each { kind: "linear"|"radius"|"diameter"|"angular"|"note", view?: "front"|"top"|"left"|"iso", text?, offset? } plus kind-specific geometry: linear { from, to }, radius/diameter { edge: EdgeQuery }, angular { from: EdgeQuery, to: EdgeQuery }, note { at, text }. from/to/at anchors are an [x,y,z] model point, { edge: EdgeQuery } or { face: FaceQuery }. Supplying any annotation REPLACES the automatic bounding-box dimensions; an annotation whose query resolves to zero or multiple matches fails the export rather than being dropped. svg-drawing sections is an array of { plane: "xy"|"xz"|"yz"|{ origin, normal }, label } (any non-zero normal). svg-drawing autoAnnotate is true or { tolerance?: "ISO2768-f"|"ISO2768-m"|"ISO2768-c", datums?: "auto"|[{ label, face: FaceQuery }], include?: ["datums"|"flatness"|"holes"|"hole-positions"|"overall"|"fillets"|"chamfers"|"general-tolerance"], dimensioningStyle?: "baseline"|"chain"|"symmetry" }; datums and tolerances declared in the script with shape.datum() / shape.tolerance() override the automatic ones. pdf-drawing: { sheet?: "a4"|"a3"|"a2"|"a1"|"a0"|"ansi-a"|"ansi-b"|"ansi-c"|"ansi-d"|"ansi-e"|"auto"|"auto-ansi" (default "a3"), projection?: "third"|"first", title?, partName?, material?, revision?, date? (default today), modelName?, views?: ["front"], annotations?, sections?, exploded?, balloons?, partsList?, autoAnnotate? (default true unless annotations are given) } — the svg-drawing keys mean the same. Mechanical SVG/PDF also accept draftingProfile?: "general"|"machining"|"sheet-metal" or { id, name, sheet, projection, dimensioningStyle, tolerance?, notes? }, with explicit options overriding profile defaults. Functional drawing review: shape.drawingReview(plan) source declarations merge with reviewPlans?: additional plans; decisionResolutions?: { [encodeURIComponent(planId)+":"+encodeURIComponent(decisionId)]: { note, provenance } }. drawing_report.review reports declared geometric-callout coverage and unresolved engineering decisions. requireCompleteReview?: true rejects incomplete/not-declared mechanical reviews before export; architectural style rejects review contracts. Coverage is not engineering certification. annotationOverrides?: { [drawing_report.annotations[i].id]: { suppress?, text?, view?, offset? } }; offset is extra nonnegative sheet mm. Text edits primary labels while preserving attached FCFs; datum/standalone FCF text is changed in its declaration instead. Suppressed rows remain in the report but not visible counts. Missing IDs warn after geometry edits. Authored annotations can set id for stable review identity. svg-drawing and pdf-drawing also take style?: "mechanical" (default, the part sheet) | "architectural" (a floor plan for a building or room model: section about 1 m above the floor with filled cut walls, wall / opening chain dimensions and overall sizes, room labels with net area, scale bar, north arrow; millimetres, or feet-inches when the model is in whole feet / inches) and plan?: { units?: "metric"|"imperial", cutHeight?: mm above the floor, rooms?: [{ name, at: [x, y] }], northDeg?: degrees clockwise from sheet up }. A building-sized model drawn in the default style gets a drawing.style.architectural-suggested warning. |
| no_verify | boolean | Skip the STL watertight verify gate. |
| feature_id | string | target:'model' — optional FeatureId to export; defaults to last. |
| output_dir | string | target:'part' — destination directory (all-parts mode); files are <dir>/<part>.stl. Hosted server: only the file name is used; the file is written to a server-owned directory and returned as a download link. |
| output_path | string | Destination path (a directory for format 'bend-table'). target:'model' — the export file (required). target:'part' — single-part .stl path. Hosted server: only the file name is used; the file is written to a server-owned directory and returned as a download link. |
{
"type": "object",
"required": [
"target"
],
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"part": {
"type": "string",
"description": "target:'part' — part name for single-part export, or 'all'."
},
"format": {
"enum": [
"stl",
"step",
"dxf",
"3mf",
"glb",
"obj",
"usd",
"svg-drawing",
"pdf-drawing",
"urdf",
"srdf",
"sdf-gazebo",
"usd-isaac",
"bom-csv",
"bom-json",
"order-pack",
"bend-table",
"gcode"
],
"type": "string",
"description": "target:'model' — output file format (required for that target)."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"target": {
"enum": [
"model",
"part"
],
"type": "string",
"description": "Which exporter to run: 'model' (whole-script geometry to one file) or 'part' (per-part STLs from a solved assembly)."
},
"options": {
"type": "object",
"description": "target:'model' — optional per-format options bag. Discriminator options.format must equal top-level format. dxf: { layers?, unit?: \"mm\"|\"cm\"|\"in\", tolerance?, section?: { axis: \"x\"|\"y\"|\"z\", at: mm }, layout?: \"per-part\"|\"sheet\" }. 3mf: { printUnit?: \"mm\"|\"cm\"|\"in\", embedSource?, arrange?: \"none\"|\"plate\"|\"assembled\", orient?: boolean, slicer?: \"generic\"|\"bambu\"|\"orca\"|\"prusa\", printer?: printer profile id, one of \"generic-fdm\"|\"bambu-a1-mini\"|\"bambu-a1\"|\"bambu-p1s\"|\"bambu-p1p\"|\"bambu-x1c\"|\"bambu-x1e\"|\"bambu-h2d\"|\"bambu-h2s\"|\"prusa-mini-plus\"|\"prusa-mk4s\"|\"prusa-core-one\"|\"prusa-xl\"|\"creality-ender-3-v3\"|\"creality-k1\"|\"creality-k1-max\"|\"creality-k2-plus\"|\"elegoo-neptune-4-pro\"|\"anycubic-kobra-3\"|\"voron-2.4-250\"|\"voron-2.4-300\"|\"voron-2.4-350\"|\"ultimaker-s5\" (default \"generic-fdm\"; sets the bed for arrange and the slicer default; an unknown id is refused with the valid list; CLI: kernelcad print printers) }; parts that do not fit the bed are still written and reported as warn diagnostics export.3mf.plate-overflow / export.3mf.exceeds-bed, whose hint names the smallest profiles the layout fits on. gcode: { printer?: printer profile id, layerHeight?: mm, infill?: percent, supports?: boolean, material?: string }; requires a locally installed OrcaSlicer. Returns slicer predictions as gcode_stats; does not start a printer. glb: { axis?: \"y-up\"|\"z-up\", draco?: false }. obj and usd are mesh exports with no extra options; usd writes ASCII USDA (millimeter, Z-up). svg-drawing: { views?: [\"front\"], sheet?: \"a4\"|\"a3\" (or any pdf-drawing sheet), projection?, titleBlock?: { title?, partName?, material?, revision? }, modelName?, date?, annotations?, exploded?: { factor, mode? }, balloons?, partsList?, sections?, autoAnnotate? }. views:[\"front\"] produces a centred front-only elevation for SVG or PDF; omit views for four views. Front-only sheets require front annotations and reject isometric balloons/exploded overlays. svg-drawing annotations is an array of authored dimensions/notes, each { kind: \"linear\"|\"radius\"|\"diameter\"|\"angular\"|\"note\", view?: \"front\"|\"top\"|\"left\"|\"iso\", text?, offset? } plus kind-specific geometry: linear { from, to }, radius/diameter { edge: EdgeQuery }, angular { from: EdgeQuery, to: EdgeQuery }, note { at, text }. from/to/at anchors are an [x,y,z] model point, { edge: EdgeQuery } or { face: FaceQuery }. Supplying any annotation REPLACES the automatic bounding-box dimensions; an annotation whose query resolves to zero or multiple matches fails the export rather than being dropped. svg-drawing sections is an array of { plane: \"xy\"|\"xz\"|\"yz\"|{ origin, normal }, label } (any non-zero normal). svg-drawing autoAnnotate is true or { tolerance?: \"ISO2768-f\"|\"ISO2768-m\"|\"ISO2768-c\", datums?: \"auto\"|[{ label, face: FaceQuery }], include?: [\"datums\"|\"flatness\"|\"holes\"|\"hole-positions\"|\"overall\"|\"fillets\"|\"chamfers\"|\"general-tolerance\"], dimensioningStyle?: \"baseline\"|\"chain\"|\"symmetry\" }; datums and tolerances declared in the script with shape.datum() / shape.tolerance() override the automatic ones. pdf-drawing: { sheet?: \"a4\"|\"a3\"|\"a2\"|\"a1\"|\"a0\"|\"ansi-a\"|\"ansi-b\"|\"ansi-c\"|\"ansi-d\"|\"ansi-e\"|\"auto\"|\"auto-ansi\" (default \"a3\"), projection?: \"third\"|\"first\", title?, partName?, material?, revision?, date? (default today), modelName?, views?: [\"front\"], annotations?, sections?, exploded?, balloons?, partsList?, autoAnnotate? (default true unless annotations are given) } — the svg-drawing keys mean the same. Mechanical SVG/PDF also accept draftingProfile?: \"general\"|\"machining\"|\"sheet-metal\" or { id, name, sheet, projection, dimensioningStyle, tolerance?, notes? }, with explicit options overriding profile defaults. Functional drawing review: shape.drawingReview(plan) source declarations merge with reviewPlans?: additional plans; decisionResolutions?: { [encodeURIComponent(planId)+\":\"+encodeURIComponent(decisionId)]: { note, provenance } }. drawing_report.review reports declared geometric-callout coverage and unresolved engineering decisions. requireCompleteReview?: true rejects incomplete/not-declared mechanical reviews before export; architectural style rejects review contracts. Coverage is not engineering certification. annotationOverrides?: { [drawing_report.annotations[i].id]: { suppress?, text?, view?, offset? } }; offset is extra nonnegative sheet mm. Text edits primary labels while preserving attached FCFs; datum/standalone FCF text is changed in its declaration instead. Suppressed rows remain in the report but not visible counts. Missing IDs warn after geometry edits. Authored annotations can set id for stable review identity. svg-drawing and pdf-drawing also take style?: \"mechanical\" (default, the part sheet) | \"architectural\" (a floor plan for a building or room model: section about 1 m above the floor with filled cut walls, wall / opening chain dimensions and overall sizes, room labels with net area, scale bar, north arrow; millimetres, or feet-inches when the model is in whole feet / inches) and plan?: { units?: \"metric\"|\"imperial\", cutHeight?: mm above the floor, rooms?: [{ name, at: [x, y] }], northDeg?: degrees clockwise from sheet up }. A building-sized model drawn in the default style gets a drawing.style.architectural-suggested warning."
},
"no_verify": {
"type": "boolean",
"default": false,
"description": "Skip the STL watertight verify gate."
},
"feature_id": {
"type": "string",
"description": "target:'model' — optional FeatureId to export; defaults to last."
},
"output_dir": {
"type": "string",
"description": "target:'part' — destination directory (all-parts mode); files are <dir>/<part>.stl. Hosted server: only the file name is used; the file is written to a server-owned directory and returned as a download link."
},
"output_path": {
"type": "string",
"description": "Destination path (a directory for format 'bend-table'). target:'model' — the export file (required). target:'part' — single-part .stl path. Hosted server: only the file name is used; the file is written to a server-owned directory and returned as a download link."
}
}
}| formats | array | Files to include. Default step, stl, 3mf, pdf-drawing, bom-csv. |
| processes | array | Only return quote links for these processes. Default: all. |
| output_dir* | string | Directory to write the pack into (created if missing). Hosted server: only the directory name is used; the pack is written in a server-owned directory and returned as download links. |
{
"type": "object",
"required": [
"output_dir"
],
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"name": {
"type": "string",
"description": "Base file name (letters, digits, '.', '_', '-'). Default 'part'."
},
"scope": {
"enum": [
"part",
"bom"
],
"type": "string",
"description": "Default 'part' (a single-part pack). 'bom' packs the whole assembly's BOM: per-part single-body files, per-part drawings, bom.csv/json, vendor handoff texts, and per-process quote links."
},
"formats": {
"type": "array",
"items": {
"enum": [
"step",
"stl",
"3mf",
"pdf-drawing",
"bom-csv",
"dxf"
],
"type": "string"
},
"description": "Files to include. Default step, stl, 3mf, pdf-drawing, bom-csv."
},
"processes": {
"type": "array",
"items": {
"enum": [
"3d-print",
"cnc",
"sheet-cut"
],
"type": "string"
},
"description": "Only return quote links for these processes. Default: all."
},
"output_dir": {
"type": "string",
"description": "Directory to write the pack into (created if missing). Hosted server: only the directory name is used; the pack is written in a server-owned directory and returned as download links."
}
}
}| string |
| Optional parts catalog endpoint, passed to find_part/fetch_part. |
| expected_sha256 | string | Required SHA-256 digest for an explicit URL; catalog hashes are used when resolving catalog records. |
| tolerance_ratio | number | Relative expected-versus-measured bbox tolerance, default 0.25. |
{
"type": "object",
"properties": {
"mpn": {
"type": "string"
},
"ref": {
"type": "string"
},
"url": {
"type": "string",
"description": "Direct public HTTPS download URL from the handoff step field."
},
"source": {
"type": "string",
"description": "Catalog or manufacturer name, such as KiCad Packages3D."
},
"bbox_mm": {
"type": "array",
"items": {
"type": "number"
},
"description": "Expected [x,y,z] dimensions from the handoff."
},
"license": {
"type": "string",
"description": "License string supplied by the source."
},
"catalog_id": {
"type": "string"
},
"attribution": {
"type": "string"
},
"partsBaseUrl": {
"type": "string",
"description": "Optional parts catalog endpoint, passed to find_part/fetch_part."
},
"expected_sha256": {
"type": "string",
"description": "Required SHA-256 digest for an explicit URL; catalog hashes are used when resolving catalog records."
},
"tolerance_ratio": {
"type": "number",
"description": "Relative expected-versus-measured bbox tolerance, default 0.25."
}
}
}{
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"limit": {
"type": "number"
},
"query": {
"type": "string"
},
"family": {
"type": "string"
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"source": {
"enum": [
"local",
"remote",
"auto"
],
"type": "string"
},
"category": {
"type": "string"
},
"standard": {
"type": "string"
},
"partsBaseUrl": {
"type": "string",
"description": "Opt-in remote endpoint; no default value ships with kernelCAD."
}
}
}| view | string | View to render. Default "all" = a labeled contact sheet of every canonical angle (iso/front/back/left/right/top) — best for judging the whole model. Pass a single view name for one large render of that angle. |
| paths_only | boolean | Controls PNG delivery. Default false: base64-inline the rendered PNG so clients that cannot fetch a URL over HTTP (e.g. a sandboxed agent) can still see it. Set true to return only metadata (smaller response). |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"description": "Project slug from open_in_studio/get_project/a /p/<slug> link. The slug is the capability — public/unlisted projects need no OAuth; private projects require the owner to be signed in."
},
"view": {
"enum": [
"all",
"iso",
"front",
"back",
"left",
"right",
"top"
],
"type": "string",
"description": "View to render. Default \"all\" = a labeled contact sheet of every canonical angle (iso/front/back/left/right/top) — best for judging the whole model. Pass a single view name for one large render of that angle."
},
"paths_only": {
"type": "boolean",
"description": "Controls PNG delivery. Default false: base64-inline the rendered PNG so clients that cannot fetch a URL over HTTP (e.g. a sandboxed agent) can still see it. Set true to return only metadata (smaller response)."
}
},
"additionalProperties": false
}| string |
| Where to write the file and starter script. Default: a new temp directory. |
| content_base64 | string | The file bytes, base64-encoded (small files). |
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Public https URL that downloads the .step/.stp/.stl file directly."
},
"name": {
"type": "string",
"description": "Base name for the written files. Default 'imported'."
},
"format": {
"enum": [
"step",
"stl"
],
"type": "string",
"description": "Override format detection."
},
"upload": {
"type": "object",
"required": [
"download_url",
"file_id"
],
"properties": {
"file_id": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"download_url": {
"type": "string"
}
},
"description": "ChatGPT file reference for a file the user attached."
},
"file_name": {
"type": "string",
"description": "Original file name, used for format detection."
},
"allow_open": {
"type": "boolean",
"default": false,
"description": "STL only: accept a non-watertight mesh as an open shell."
},
"output_dir": {
"type": "string",
"description": "Where to write the file and starter script. Default: a new temp directory."
},
"content_base64": {
"type": "string",
"description": "The file bytes, base64-encoded (small files)."
}
}
}| Argument | Type | Description |
|---|---|---|
| at | number | of:'section' — single slice position along `axis` (mm). |
| of* | string | Which facts to read. |
| axis | string | of:'section' — normal axis for `at` / `stack` (default 'z'). |
| code | string | Inline kernelCAD script source. |
| file | string | Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. Hosted server: pass an https:// URL, a data: URI, or "asset:<id>" from request_upload — not a path on your machine. |
| edges | object | array | string | of:'continuity' — optional EdgeQuery or @kc[...] ref(s) limiting which shared edges are sampled. |
| faces | object | array | string | of:'curvature' — optional FaceQuery or @kc[...] ref(s) limiting which faces are sampled. |
| plane | string | object | of:'section' — section plane. Either a cardinal name string 'xy'|'xz'|'yz', { plane: 'xy'|'xz'|'yz', offset? }, or { origin: [x,y,z], normal: [nx,ny,nz] }. Omit to use `at`+`axis`. |
| query | object | of:'edges'|'faces' — optional EdgeQuery/FaceQuery filter. |
| stack | object | of:'section' — dense scan: `count` slices evenly spaced from `from` to `to` along `axis`; response reports minAreaIndex/minAreaPosition. |
| density | number | of:'mass' — material density in kg/m^3 (steel 7850, aluminium 2700, ABS 1050). Defaults to 1000 (water); the response echoes the value used and flags when it was defaulted. |
| assembly | string | of:'assembly'|'robot'|'bom' — assembly name; defaults to the first captured assembly. |
| category | string | of:'part-families' — optional top-level category to filter families by. |
| face_name | string | of:'face-edges' — canonical face name (required for that subject). |
| feature_id | string | of:'shape'|'mass'|'topology'|'edges'|'faces'|'face-edges'|'face-labels' — FeatureId; defaults to the last returned shape. |
| spike_factor | number | of:'curvature' — spike sensitivity as a multiple of the face's Gaussian stddev (default 6). |
| gyration_axis | object | of:'mass' — optional axis in shape-local mm to report the radius of gyration about. Omit for centroidal quantities only; the result is density-independent and returned in mm. |
{
"type": "object",
"required": [
"of"
],
"properties": {
"at": {
"type": "number",
"description": "of:'section' — single slice position along `axis` (mm)."
},
"of": {
"enum": [
"assembly",
"robot",
"step",
"shape",
"mass",
"features",
"assemblies",
"topology",
"edges",
"face-edges",
"faces",
"face-labels",
"mates",
"constraints",
"part-stats",
"bend-table",
"params",
"part-categories",
"part-families",
"bom",
"section",
"continuity",
"curvature",
"multi-material"
],
"type": "string",
"description": "Which facts to read."
},
"axis": {
"enum": [
"x",
"y",
"z"
],
"type": "string",
"description": "of:'section' — normal axis for `at` / `stack` (default 'z')."
},
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. Hosted server: pass an https:// URL, a data: URI, or \"asset:<id>\" from request_upload — not a path on your machine."
},
"edges": {
"type": [
"object",
"array",
"string"
],
"description": "of:'continuity' — optional EdgeQuery or @kc[...] ref(s) limiting which shared edges are sampled."
},
"faces": {
"type": [
"object",
"array",
"string"
],
"description": "of:'curvature' — optional FaceQuery or @kc[...] ref(s) limiting which faces are sampled."
},
"plane": {
"type": [
"string",
"object"
],
"description": "of:'section' — section plane. Either a cardinal name string 'xy'|'xz'|'yz', { plane: 'xy'|'xz'|'yz', offset? }, or { origin: [x,y,z], normal: [nx,ny,nz] }. Omit to use `at`+`axis`."
},
"query": {
"type": "object",
"description": "of:'edges'|'faces' — optional EdgeQuery/FaceQuery filter."
},
"stack": {
"type": "object",
"required": [
"from",
"to",
"count"
],
"properties": {
"to": {
"type": "number",
"description": "End position along the axis (mm)."
},
"axis": {
"enum": [
"x",
"y",
"z"
],
"type": "string",
"description": "Scan axis (default 'z')."
},
"from": {
"type": "number",
"description": "Start position along the axis (mm)."
},
"count": {
"type": "integer",
"description": "Number of evenly spaced slices (>= 1)."
}
},
"description": "of:'section' — dense scan: `count` slices evenly spaced from `from` to `to` along `axis`; response reports minAreaIndex/minAreaPosition."
},
"density": {
"type": "number",
"description": "of:'mass' — material density in kg/m^3 (steel 7850, aluminium 2700, ABS 1050). Defaults to 1000 (water); the response echoes the value used and flags when it was defaulted."
},
"assembly": {
"type": "string",
"description": "of:'assembly'|'robot'|'bom' — assembly name; defaults to the first captured assembly."
},
"category": {
"type": "string",
"description": "of:'part-families' — optional top-level category to filter families by."
},
"face_name": {
"enum": [
"top",
"bottom",
"left",
"right",
"front",
"back"
],
"type": "string",
"description": "of:'face-edges' — canonical face name (required for that subject)."
},
"feature_id": {
"type": "string",
"description": "of:'shape'|'mass'|'topology'|'edges'|'faces'|'face-edges'|'face-labels' — FeatureId; defaults to the last returned shape."
},
"spike_factor": {
"type": "number",
"description": "of:'curvature' — spike sensitivity as a multiple of the face's Gaussian stddev (default 6)."
},
"gyration_axis": {
"type": "object",
"required": [
"origin",
"direction"
],
"properties": {
"origin": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "A point on the axis, shape-local mm."
},
"direction": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Axis direction; normalised internally, so it need not be a unit vector."
}
},
"description": "of:'mass' — optional axis in shape-local mm to report the radius of gyration about. Omit for centroidal quantities only; the result is density-independent and returned in mm."
}
}
}| data | string | Mesh bytes as base64 — use when the server cannot see your filesystem. |
| file | string | Path to a .stl (binary or ASCII), .obj or .3mf mesh. One of file / data is required. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. Hosted server: pass an https:// URL, a data: URI, or "asset:<id>" from request_upload — not a path on your machine. |
| format | string | Format override; default from the extension or the content. |
| minIoU | number | Volume IoU a faithful verdict requires. Default 0.98. |
| maxPasses | number | Refinement passes, 1–4. Default 4; stops early at the first faithful pass. |
| maxTriangles | number | Refuse meshes above this triangle count instead of stalling. Default 300000. |
| maxDeviationMm | number | Max surface deviation (mm) a faithful verdict allows. Default max(0.25, 0.1 % of the bbox diagonal). |
| weldToleranceMm | number | Vertex weld distance in mm. Default max(1e-4, 1e-6 × bbox diagonal). |
{
"type": "object",
"properties": {
"out": {
"type": "string",
"description": "Write the emitted script to this .kcad.ts path and the assumption ledger to the sibling .ledger.json."
},
"data": {
"type": "string",
"description": "Mesh bytes as base64 — use when the server cannot see your filesystem."
},
"file": {
"type": "string",
"description": "Path to a .stl (binary or ASCII), .obj or .3mf mesh. One of file / data is required. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. Hosted server: pass an https:// URL, a data: URI, or \"asset:<id>\" from request_upload — not a path on your machine."
},
"format": {
"enum": [
"stl",
"obj",
"3mf"
],
"type": "string",
"description": "Format override; default from the extension or the content."
},
"minIoU": {
"type": "number",
"description": "Volume IoU a faithful verdict requires. Default 0.98."
},
"maxPasses": {
"type": "number",
"description": "Refinement passes, 1–4. Default 4; stops early at the first faithful pass."
},
"maxTriangles": {
"type": "number",
"description": "Refuse meshes above this triangle count instead of stalling. Default 300000."
},
"maxDeviationMm": {
"type": "number",
"description": "Max surface deviation (mm) a faithful verdict allows. Default max(0.25, 0.1 % of the bbox diagonal)."
},
"weldToleranceMm": {
"type": "number",
"description": "Vertex weld distance in mm. Default max(1e-4, 1e-6 × bbox diagonal)."
}
}
}| Argument | Type | Description |
|---|---|---|
| code | string | The full .kcad source of the model to open in Studio (the script you have been editing). Optional: omit to reuse the source from your most recent evaluate_script call. |
| slug | string | Older name for `project`. Use `project`. |
| title | string | Optional human-readable title for the model (shown in Studio). Defaults to "Model from Claude". |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| wheels | array | Wheel centres + radii for likeness gate [{ center:[x,y,z], radius }]. |
| project | string | Slug of the project to update (from the last open_in_studio result, a "Saved to your projects" note, list_my_projects, or a /p/<slug> link). Adds a new revision to that project instead of creating a new one, and live-updates the user's open Studio tab. |
| body_bbox | object | Body AABB { min:[x,y,z], max:[x,y,z] } mm — for likeness_profile gate when no session attest. |
| anon_token | string | Anonymous owner token returned as `anonToken` by an earlier open_in_studio result. Pass it on every open_in_studio call, also in a new chat, so all your anonymous projects stay together and move to the user's account when they sign in. Omit when you have none. |
| cabin_bbox | object | Optional cabin AABB for likeness gate. |
| parameters | array | Optional list of the model's editable parameters, so Studio can render parameter controls. Each item is one control derived from the .kcad params. |
| attachments | array | Complementary project files referenced by relative path from the .kcad source. |
| new_project | boolean | Pass true only when the user wants a separate, new design. Default: continue this chat's project, or your project with the same title from the last 24 h. Still wins over a matching title or cookbook. |
| require_stills | boolean | Forwarded to body-likeness gate (default true). |
| still_verdicts | array | Agent still checklist for likeness gate [{ code, passed, finding, view? }]. |
| continue_design | boolean | Pass true to add a revision to the design this chat is already saving, even when this call is a different cookbook or title. Ignored when `project` is set. |
| include_preview | boolean | Default true: render an iso PNG preview into this same tool result (reuses the server render cache when this source was already rendered). Set false to skip rasterization and return save/viewer URLs only. |
| likeness_profile | string | Hard success gate for organic/car bodies. When set, open_in_studio returns ok:false unless body-likeness is publishReady (inline body_bbox/wheels/still_verdicts, or a prior verify body-likeness pass for this exact code). Omit for WIP previews. |
{
"type": "object",
"required": [],
"properties": {
"code": {
"type": "string",
"minLength": 1,
"description": "The full .kcad source of the model to open in Studio (the script you have been editing). Optional: omit to reuse the source from your most recent evaluate_script call."
},
"slug": {
"type": "string",
"minLength": 1,
"description": "Older name for `project`. Use `project`."
},
"title": {
"type": "string",
"description": "Optional human-readable title for the model (shown in Studio). Defaults to \"Model from Claude\"."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"wheels": {
"type": "array",
"items": {
"type": "object"
},
"description": "Wheel centres + radii for likeness gate [{ center:[x,y,z], radius }]."
},
"project": {
"type": "string",
"minLength": 1,
"description": "Slug of the project to update (from the last open_in_studio result, a \"Saved to your projects\" note, list_my_projects, or a /p/<slug> link). Adds a new revision to that project instead of creating a new one, and live-updates the user's open Studio tab."
},
"body_bbox": {
"type": "object",
"description": "Body AABB { min:[x,y,z], max:[x,y,z] } mm — for likeness_profile gate when no session attest."
},
"anon_token": {
"type": "string",
"maxLength": 128,
"description": "Anonymous owner token returned as `anonToken` by an earlier open_in_studio result. Pass it on every open_in_studio call, also in a new chat, so all your anonymous projects stay together and move to the user's account when they sign in. Omit when you have none."
},
"cabin_bbox": {
"type": "object",
"description": "Optional cabin AABB for likeness gate."
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"defaultValue",
"kind"
],
"properties": {
"max": {
"type": "number",
"description": "Optional inclusive upper bound (numeric params)."
},
"min": {
"type": "number",
"description": "Optional inclusive lower bound (numeric params)."
},
"kind": {
"enum": [
"number",
"integer",
"boolean",
"string"
],
"type": "string",
"description": "Control type Studio should render for this parameter."
},
"name": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Parameter identifier as used in the script (e.g. \"width\")."
},
"step": {
"type": "number",
"description": "Optional slider/step increment (numeric params)."
},
"unit": {
"type": "string",
"maxLength": 8,
"description": "Optional unit label shown next to the control (e.g. \"mm\", \"deg\")."
},
"description": {
"type": "string",
"maxLength": 200,
"description": "Optional human-readable explanation of the parameter."
},
"defaultValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "string"
}
],
"description": "Current/default value of the parameter; type matches `kind`."
}
}
},
"description": "Optional list of the model's editable parameters, so Studio can render parameter controls. Each item is one control derived from the .kcad params."
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"maxLength": 240,
"minLength": 1
},
"assetSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytesBase64": {
"type": "string"
}
},
"additionalProperties": false
},
"maxItems": 32,
"description": "Complementary project files referenced by relative path from the .kcad source."
},
"new_project": {
"type": "boolean",
"description": "Pass true only when the user wants a separate, new design. Default: continue this chat's project, or your project with the same title from the last 24 h. Still wins over a matching title or cookbook."
},
"require_stills": {
"type": "boolean",
"description": "Forwarded to body-likeness gate (default true)."
},
"still_verdicts": {
"type": "array",
"items": {
"type": "object"
},
"description": "Agent still checklist for likeness gate [{ code, passed, finding, view? }]."
},
"continue_design": {
"type": "boolean",
"description": "Pass true to add a revision to the design this chat is already saving, even when this call is a different cookbook or title. Ignored when `project` is set."
},
"include_preview": {
"type": "boolean",
"description": "Default true: render an iso PNG preview into this same tool result (reuses the server render cache when this source was already rendered). Set false to skip rasterization and return save/viewer URLs only."
},
"likeness_profile": {
"enum": [
"automotive"
],
"type": "string",
"description": "Hard success gate for organic/car bodies. When set, open_in_studio returns ok:false unless body-likeness is publishReady (inline body_bbox/wheels/still_verdicts, or a prior verify body-likeness pass for this exact code). Omit for WIP previews."
}
},
"additionalProperties": false
}| scaleMode |
| string |
| Drawing.sketchOnFace scaling mode. Default original. |
{
"type": "object",
"required": [
"code",
"target",
"commands",
"face"
],
"properties": {
"code": {
"type": "string",
"description": "The .kcad.ts source code."
},
"face": {
"type": "string",
"description": "Target face — canonical name or label."
},
"asEdge": {
"type": "boolean",
"description": "Open-wire (edge) projection. NOT IMPLEMENTED — rejected at edit time. Use a closed-curve projection (omit asEdge)."
},
"bindAs": {
"type": "string",
"description": "Optional local variable name; emits `const <bindAs> = <target>.projectCurve(...);`."
},
"target": {
"type": "string",
"description": "Variable name of the Shape to chain onto."
},
"commands": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"kind": {
"enum": [
"moveTo",
"lineTo",
"close"
],
"type": "string"
}
}
},
"description": "Closed 2D path to wrap onto the face, as plain-number commands. Must start with a `moveTo` and end with a `close` (e.g. [{kind:\"moveTo\",x:0,y:0},{kind:\"lineTo\",x:2,y:0},{kind:\"lineTo\",x:2,y:2},{kind:\"close\"}])."
},
"scaleMode": {
"enum": [
"original",
"native",
"bounds"
],
"type": "string",
"description": "Drawing.sketchOnFace scaling mode. Default original."
}
}
}| query | string | object | mode:'evaluate' — Query: a bare face label ('top'), an @kc[<feature-id>/face/<label>] ref, an @kcq[face(...)] expression, or { ast }. |
| expect | string | mode:'evaluate' — 'unique' asserts exactly-one. |
| feature_id | string | Optional FeatureId; defaults to the last lowered shape (use "auto" for lineage). |
{
"type": "object",
"properties": {
"ref": {
"type": "string",
"description": "mode:'resolve'|'lineage' — one face: '@kc[box_1/face/top]', '@kcq[...]', or '<feature-id>.<label>' (lineage)."
},
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"mode": {
"enum": [
"evaluate",
"resolve",
"lineage"
],
"type": "string",
"description": "Resolution mode (default 'evaluate')."
},
"query": {
"type": [
"string",
"object"
],
"description": "mode:'evaluate' — Query: a bare face label ('top'), an @kc[<feature-id>/face/<label>] ref, an @kcq[face(...)] expression, or { ast }."
},
"expect": {
"enum": [
"any",
"unique"
],
"type": "string",
"description": "mode:'evaluate' — 'unique' asserts exactly-one."
},
"feature_id": {
"type": "string",
"description": "Optional FeatureId; defaults to the last lowered shape (use \"auto\" for lineage)."
}
}
}| studio_url* | string | Local Studio HTTP origin, e.g. http://localhost:5173. |
{
"type": "object",
"allOf": [
{
"oneOf": [
{
"not": {
"required": [
"code"
]
},
"required": [
"file"
]
},
{
"not": {
"required": [
"file"
]
},
"required": [
"code"
]
}
]
}
],
"required": [
"origin",
"direction",
"studio_url",
"session"
],
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"origin": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Ray origin [x, y, z] in model units."
},
"session": {
"type": "string",
"minLength": 1,
"description": "Studio sessionToken for this script, from GET /__kernelcad/session?script=<path>."
},
"direction": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "Nonzero ray direction [x, y, z]; normalized internally."
},
"feature_id": {
"type": "string",
"description": "Displayed terminal feature to ray-pick; defaults to the returned feature. Intermediate features are not available as current viewer selections."
},
"studio_url": {
"type": "string",
"description": "Local Studio HTTP origin, e.g. http://localhost:5173."
}
}
}| Argument | Type | Description |
|---|---|---|
| code | string | Inline kernelCAD script source. Mutually exclusive with file. Relative imports resolve against a temp dir — use file for scripts with relative lib.fromSTEP(...) imports. |
| file | string | Path to a .kcad.ts script on disk. Mutually exclusive with code. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| hide | array | Hide matching feature ids / assembly part names. Mutually exclusive with focus. |
| pose | string | Extra arbitrary camera pose '<az>,<el>' in degrees, e.g. '30,20'. |
| focus | array | Show only matching feature ids / assembly part names. Mutually exclusive with hide. |
| sheet | boolean | Also write one labelled image 'sheet' tiling every rendered view. With no views it renders all seven (adds back, left, bottom) — use it before calling a model done, so a missing cutout on the back or underside is not missed. |
| views | array | Canonical views to render as an array, e.g. ["iso"] or ["front","top"] (default: all four). Fewer views = faster. |
| width | integer | Per-view tile width in px (default 768; 1600 under preset: 'publish'). |
| height | integer | Per-view tile height in px (default 768; 1200 under preset: 'publish'). |
| intent | string | The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data. |
| preset | string | Render look: 'default' (engineering review) or 'publish' (studio product shot for sharing; one 'hero' image unless views/pose are given). |
| shadow | boolean | preset 'publish' only: soft contact shadow under the model (default true). |
| explode | object | Pull a multi-part assembly apart for the preview. factor ≥ 0 scales spacing by part size; mode is 'mate-axis' (default, along parent mate/joint axes) or 'radial' (away from the assembly centroid). Requires the script to return assembly.model() / solvedModel(). |
| out_dir | string | Directory for the PNGs (created if missing). Default: a fresh temp session dir. |
| overlay | string | Surface-quality overlay: 'zebra' (reflection stripes), 'curvature' (Gaussian vertex colours), 'continuity' (edges coloured G2 green / G1 yellow / G0 orange / broken red). Built as coloured STL bands through this same pipeline. |
| section | object | Cut the model with one axis-aligned section plane to inspect INTERIOR structure (wall thickness, internal pockets, whether a bore runs through) instead of only the outer shell. position is in mm along the axis (kernelCAD Z-up frame); flip keeps the +axis side (default keeps the -axis side). |
| shading | string | Mesh shading: 'smooth' uses the kernel's vertex normals (default); 'flat' uses face normals to expose tessellation / surface wobble. |
| base_url | string | Advanced: force a specific render server (e.g. a running studio dev server) instead of the bundled static player. |
| background | string | preset 'publish' only: 'white' (default), 'light', 'dark', 'black', 'transparent' (PNG alpha), or '#rrggbb'. |
| environment | string | HDRI environment override: preset ('studio', 'softbox', 'neutral', 'outdoor', 'warehouse'), a URL, or 'none' for the default three-light rig. |
| no_watermark | boolean | Suppress the kernelCAD version watermark. |
| no_mechanism_check | boolean | Skip the mechanism-truth probe for fast iteration on large assemblies; the preview reports mechanism: 'unverified'. Ignored under KERNELCAD_RENDER_STRICT=1. |
| screenshot_timeout_ms | integer | Playwright screenshot deadline in milliseconds. Default leaves Playwright's 30 s in place; raise it for heavy lofts or a slow machine. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source. Mutually exclusive with file. Relative imports resolve against a temp dir — use file for scripts with relative lib.fromSTEP(...) imports."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script on disk. Mutually exclusive with code. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"hide": {
"type": "array",
"items": {
"type": "string"
},
"description": "Hide matching feature ids / assembly part names. Mutually exclusive with focus."
},
"pose": {
"type": "string",
"description": "Extra arbitrary camera pose '<az>,<el>' in degrees, e.g. '30,20'."
},
"focus": {
"type": "array",
"items": {
"type": "string"
},
"description": "Show only matching feature ids / assembly part names. Mutually exclusive with hide."
},
"sheet": {
"type": "boolean",
"default": false,
"description": "Also write one labelled image 'sheet' tiling every rendered view. With no views it renders all seven (adds back, left, bottom) — use it before calling a model done, so a missing cutout on the back or underside is not missed."
},
"views": {
"type": "array",
"items": {
"enum": [
"front",
"right",
"top",
"iso"
],
"type": "string"
},
"description": "Canonical views to render as an array, e.g. [\"iso\"] or [\"front\",\"top\"] (default: all four). Fewer views = faster."
},
"width": {
"type": "integer",
"maximum": 2048,
"minimum": 64,
"description": "Per-view tile width in px (default 768; 1600 under preset: 'publish')."
},
"height": {
"type": "integer",
"maximum": 2048,
"minimum": 64,
"description": "Per-view tile height in px (default 768; 1200 under preset: 'publish')."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"preset": {
"enum": [
"default",
"publish"
],
"type": "string",
"description": "Render look: 'default' (engineering review) or 'publish' (studio product shot for sharing; one 'hero' image unless views/pose are given)."
},
"shadow": {
"type": "boolean",
"description": "preset 'publish' only: soft contact shadow under the model (default true)."
},
"explode": {
"type": "object",
"required": [
"factor"
],
"properties": {
"mode": {
"enum": [
"radial",
"mate-axis"
],
"type": "string"
},
"factor": {
"type": "number",
"minimum": 0
}
},
"description": "Pull a multi-part assembly apart for the preview. factor ≥ 0 scales spacing by part size; mode is 'mate-axis' (default, along parent mate/joint axes) or 'radial' (away from the assembly centroid). Requires the script to return assembly.model() / solvedModel().",
"additionalProperties": false
},
"out_dir": {
"type": "string",
"description": "Directory for the PNGs (created if missing). Default: a fresh temp session dir."
},
"overlay": {
"enum": [
"zebra",
"curvature",
"continuity"
],
"type": "string",
"description": "Surface-quality overlay: 'zebra' (reflection stripes), 'curvature' (Gaussian vertex colours), 'continuity' (edges coloured G2 green / G1 yellow / G0 orange / broken red). Built as coloured STL bands through this same pipeline."
},
"section": {
"type": "object",
"required": [
"axis",
"position"
],
"properties": {
"axis": {
"enum": [
"x",
"y",
"z"
],
"type": "string"
},
"flip": {
"type": "boolean",
"default": false
},
"position": {
"type": "number"
}
},
"description": "Cut the model with one axis-aligned section plane to inspect INTERIOR structure (wall thickness, internal pockets, whether a bore runs through) instead of only the outer shell. position is in mm along the axis (kernelCAD Z-up frame); flip keeps the +axis side (default keeps the -axis side).",
"additionalProperties": false
},
"shading": {
"enum": [
"smooth",
"flat"
],
"type": "string",
"description": "Mesh shading: 'smooth' uses the kernel's vertex normals (default); 'flat' uses face normals to expose tessellation / surface wobble."
},
"base_url": {
"type": "string",
"description": "Advanced: force a specific render server (e.g. a running studio dev server) instead of the bundled static player."
},
"background": {
"type": "string",
"description": "preset 'publish' only: 'white' (default), 'light', 'dark', 'black', 'transparent' (PNG alpha), or '#rrggbb'."
},
"environment": {
"type": "string",
"description": "HDRI environment override: preset ('studio', 'softbox', 'neutral', 'outdoor', 'warehouse'), a URL, or 'none' for the default three-light rig."
},
"no_watermark": {
"type": "boolean",
"default": false,
"description": "Suppress the kernelCAD version watermark."
},
"no_mechanism_check": {
"type": "boolean",
"default": false,
"description": "Skip the mechanism-truth probe for fast iteration on large assemblies; the preview reports mechanism: 'unverified'. Ignored under KERNELCAD_RENDER_STRICT=1."
},
"screenshot_timeout_ms": {
"type": "integer",
"maximum": 600000,
"minimum": 1000,
"description": "Playwright screenshot deadline in milliseconds. Default leaves Playwright's 30 s in place; raise it for heavy lofts or a slow machine."
}
}
}| max_attempts |
| integer |
| Upper bound on candidates attempted (default 3). Ignored by apply-first and dry-run. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"strategy": {
"enum": [
"apply-first",
"try-all",
"dry-run"
],
"type": "string",
"description": "'try-all' (default) walks candidates until one clears the diagnostic; 'apply-first' applies only the top candidate and reports what it did; 'dry-run' previews every candidate patch without evaluating."
},
"diagnostic": {
"type": "string",
"description": "Diagnostic id from why_did_this_fail's `targetDiagnosticId` / `candidates[].diagnosticId`, or 'first-error' (default) for the first error-severity diagnostic."
},
"max_attempts": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Upper bound on candidates attempted (default 3). Ignored by apply-first and dry-run."
}
}
}| timeBudgetMs | number | Wall-clock budget for the review in ms (default 90000). Once spent, the remaining heavy stages (pose envelope, physical use case, mechanism sweep) are skipped and listed in skippedStages — a partial result instead of a timeout. stageTimingsMs reports where the time went. |
| combinatorial | boolean | Sample all 2^N limit-corner combinations across mates with declared limits. Capped at 8 mates with limits; combine with samplesPerMate for both interior coverage and worst-pose detection. Default false. |
| samplesPerMate | integer | Pose-envelope samples per declared-limit mate. 1 (default) = corners only; >=3 adds uniform interior points between min and max. Total samples per non-locked mate = samplesPerMate. |
| gripperAperture | object | Optional fingertip connector refs for gripper aperture travel reporting. |
| trackConnectors | array | Optional connector refs such as ["gripper-plate.tool-tip"] to limit connector workspace reporting. |
| preserveInterfaces | array | External mates, connector refs, part names, or behavioral interfaces the repair agent must preserve during redesign. |
| includeInterference | boolean | Whether sampled poses run BREP interference checks. Default true. |
| includePoseEnvelope | boolean | Whether to sample declared mate limits. Default true. |
| requirePhysicalUseCase | boolean | When true, articulated assemblies must declare arm.physicalUseCase(...) evidence: loads, contacts, stable parts, and actuator limits. |
| includePhysicalUseCaseStatics | boolean | Run opt-in pose-bound quasi-static certification at the exact common-contact samples: conservative friction/capacity, world force and moment balance, and finite-difference revolute actuator torque. Returns physicalUseCaseStaticCertificates on success; sampled linearized failures remain blocking diagnostics. |
| includePhysicalUseCaseReachability | boolean | Run targeted physical-use-case reachability sampling over scalar-limited mates named in actuatorLimits. Reject contacts that cannot get within criteria.maxSlipMm and multi-contact use cases that cannot satisfy every contact in the same sampled actuator pose. Samples revolute/cylindrical/pin-slot limitsDeg and prismatic limitsMm. Defaults to requirePhysicalUseCase. |
| includePhysicalUseCaseJointReactions | boolean | Derive exact-pose reaction wrenches through uniquely rooted articulated trees and compare every loaded mate against a complete declared resultant force/moment envelope. Implies physical-use-case reachability and statics. |
| includePhysicalUseCaseJointStructure | boolean | Run geometry/material clevis double-shear, pin-bending, bearing, tear-out, and net-section checks with minimum factor of safety 2. Unsupported axial or perpendicular-moment load cases remain blockers. Implies joint reactions, statics, and reachability. |
| physicalUseCaseReachabilitySamplesPerMate | integer | Samples per scalar-limited actuator mate for physical-use-case contact reachability. Samples revolute/cylindrical/pin-slot limitsDeg and prismatic limitsMm. Default 3; total targeted combinations are capped. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script file. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"assembly": {
"type": "string",
"description": "Assembly name; defaults to the first captured assembly."
},
"designGoal": {
"type": "string",
"description": "Original user design prompt or goal. Included in suggestedRepairPrompt so topology-redesign repairs restart from the intended physical design instead of local coordinate nudges."
},
"epsilonMm3": {
"type": "number",
"description": "Interference volume threshold in mm^3. Default 0.01."
},
"timeBudgetMs": {
"type": "number",
"description": "Wall-clock budget for the review in ms (default 90000). Once spent, the remaining heavy stages (pose envelope, physical use case, mechanism sweep) are skipped and listed in skippedStages — a partial result instead of a timeout. stageTimingsMs reports where the time went."
},
"combinatorial": {
"type": "boolean",
"description": "Sample all 2^N limit-corner combinations across mates with declared limits. Capped at 8 mates with limits; combine with samplesPerMate for both interior coverage and worst-pose detection. Default false."
},
"samplesPerMate": {
"type": "integer",
"minimum": 1,
"description": "Pose-envelope samples per declared-limit mate. 1 (default) = corners only; >=3 adds uniform interior points between min and max. Total samples per non-locked mate = samplesPerMate."
},
"gripperAperture": {
"type": "object",
"properties": {
"left": {
"type": "string",
"description": "Left fingertip connector ref such as \"left-finger.tip\"."
},
"right": {
"type": "string",
"description": "Right fingertip connector ref such as \"right-finger.tip\"."
}
},
"description": "Optional fingertip connector refs for gripper aperture travel reporting."
},
"trackConnectors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional connector refs such as [\"gripper-plate.tool-tip\"] to limit connector workspace reporting."
},
"preserveInterfaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "External mates, connector refs, part names, or behavioral interfaces the repair agent must preserve during redesign."
},
"includeInterference": {
"type": "boolean",
"description": "Whether sampled poses run BREP interference checks. Default true."
},
"includePoseEnvelope": {
"type": "boolean",
"description": "Whether to sample declared mate limits. Default true."
},
"requirePhysicalUseCase": {
"type": "boolean",
"description": "When true, articulated assemblies must declare arm.physicalUseCase(...) evidence: loads, contacts, stable parts, and actuator limits."
},
"includePhysicalUseCaseStatics": {
"type": "boolean",
"description": "Run opt-in pose-bound quasi-static certification at the exact common-contact samples: conservative friction/capacity, world force and moment balance, and finite-difference revolute actuator torque. Returns physicalUseCaseStaticCertificates on success; sampled linearized failures remain blocking diagnostics."
},
"includePhysicalUseCaseReachability": {
"type": "boolean",
"description": "Run targeted physical-use-case reachability sampling over scalar-limited mates named in actuatorLimits. Reject contacts that cannot get within criteria.maxSlipMm and multi-contact use cases that cannot satisfy every contact in the same sampled actuator pose. Samples revolute/cylindrical/pin-slot limitsDeg and prismatic limitsMm. Defaults to requirePhysicalUseCase."
},
"includePhysicalUseCaseJointReactions": {
"type": "boolean",
"description": "Derive exact-pose reaction wrenches through uniquely rooted articulated trees and compare every loaded mate against a complete declared resultant force/moment envelope. Implies physical-use-case reachability and statics."
},
"includePhysicalUseCaseJointStructure": {
"type": "boolean",
"description": "Run geometry/material clevis double-shear, pin-bending, bearing, tear-out, and net-section checks with minimum factor of safety 2. Unsupported axial or perpendicular-moment load cases remain blockers. Implies joint reactions, statics, and reachability."
},
"physicalUseCaseReachabilitySamplesPerMate": {
"type": "integer",
"minimum": 1,
"description": "Samples per scalar-limited actuator mate for physical-use-case contact reachability. Samples revolute/cylindrical/pin-slot limitsDeg and prismatic limitsMm. Default 3; total targeted combinations are capped."
}
}
}{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Project slug from open_in_studio/get_project/a /p/<slug> link. When given, returns the latest brush packet painted on that project's page — works without OAuth; the slug is the capability. Omit to use your signed-in account's latest packet."
},
"paths_only": {
"type": "boolean",
"description": "Controls PNG delivery. Default (omitted or true): return only signed URLs + struck part names — the small, context-friendly response; fetch the bytes via the signed URLs. Set false to also base64-inline the screenshot + mask PNGs for clients that cannot fetch the URLs over HTTP (larger response)."
},
"freshness_sec": {
"type": "integer",
"minimum": 1,
"description": "Maximum packet age in seconds. Default 1800 (30 min). Use a smaller value for \"what did I just paint\" or a larger one for \"earlier today\"."
}
},
"additionalProperties": false
}| code |
| string |
| Inline kernelCAD script source (mutually exclusive with file). |
| file | string | Path to a .kcad.ts script declaring at least one feaStudy. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| fixed | string | object | Inline study: faces held fixed — a FaceQuery like { atX: 0 }, a face label like 'bottom', or an @kc[...] ref. |
| loads | array | Inline study: loads, each { faces, force: [Fx, Fy, Fz] } — total force in N on those faces. |
| study | string | Name of the declared study to run; defaults to the last declared one. |
| refine | boolean | One automatic finer pass (0.75x element size) when the stress is untrusted, inside the element budget (default true). false: one solve at mesh_size. |
| solver | string | 'auto' (default): CalculiX when installed, else in-process. 'calculix': require it. 'in-process': always the built-in voxel solver. |
| heatmaps | boolean | Render stress heatmap PNGs (default true). |
| material | string | object | Inline study: material grade name (e.g. 'aluminum-6061') or { E, nu, yield } in MPa. |
| mesh_size | number | Target element size in mm, overriding the study for this run. |
| output_dir | string | Directory for the solver deck, results, summary JSON and heatmap PNGs. |
| mesh_timeout_ms | number | Wall-clock budget for meshing (default 120000). |
| solve_timeout_ms | number | Wall-clock budget for the solve (default 300000). |
| min_safety_factor | number | Inline study: required minimum safety factor; below it the call fails with fea.safety-factor.below-min. |
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Inline kernelCAD script source (mutually exclusive with file)."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script declaring at least one feaStudy. Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"fixed": {
"type": [
"string",
"object"
],
"description": "Inline study: faces held fixed — a FaceQuery like { atX: 0 }, a face label like 'bottom', or an @kc[...] ref."
},
"loads": {
"type": "array",
"items": {
"type": "object"
},
"description": "Inline study: loads, each { faces, force: [Fx, Fy, Fz] } — total force in N on those faces."
},
"study": {
"type": "string",
"description": "Name of the declared study to run; defaults to the last declared one."
},
"refine": {
"type": "boolean",
"description": "One automatic finer pass (0.75x element size) when the stress is untrusted, inside the element budget (default true). false: one solve at mesh_size."
},
"solver": {
"enum": [
"auto",
"calculix",
"in-process"
],
"type": "string",
"description": "'auto' (default): CalculiX when installed, else in-process. 'calculix': require it. 'in-process': always the built-in voxel solver."
},
"heatmaps": {
"type": "boolean",
"description": "Render stress heatmap PNGs (default true)."
},
"material": {
"type": [
"string",
"object"
],
"description": "Inline study: material grade name (e.g. 'aluminum-6061') or { E, nu, yield } in MPa."
},
"mesh_size": {
"type": "number",
"description": "Target element size in mm, overriding the study for this run."
},
"output_dir": {
"type": "string",
"description": "Directory for the solver deck, results, summary JSON and heatmap PNGs."
},
"mesh_timeout_ms": {
"type": "number",
"description": "Wall-clock budget for meshing (default 120000)."
},
"solve_timeout_ms": {
"type": "number",
"description": "Wall-clock budget for the solve (default 300000)."
},
"min_safety_factor": {
"type": "number",
"description": "Inline study: required minimum safety factor; below it the call fails with fea.safety-factor.below-min."
}
}
}| OctoPrint API key (Settings -> API). |
| dry_run | boolean | Validate connectivity/auth only; never uploads or starts a print. |
| printer | string | Printer profile id; checked against protocol before upload. List them with 'kernelcad print printers'. |
| filename | string | Uploaded file name (default: 'kernelcad.gcode'; bambu-lan appends '.3mf'). |
| protocol* | string |
| gcode_path* | string | Path to the .gcode file on disk. |
| access_code | string | Bambu LAN-mode access code (printer settings -> LAN Only Mode). |
| start_print | boolean | Start the print immediately after upload (default: true). |
| model_3mf_path | string | bambu-lan only: model .3mf from export format '3mf' to package the G-code into (the uploaded .gcode.3mf). |
{
"type": "object",
"required": [
"gcode_path",
"protocol",
"host"
],
"properties": {
"host": {
"type": "string",
"description": "Printer hostname or IP."
},
"port": {
"type": "number",
"description": "Override the protocol default port."
},
"serial": {
"type": "string",
"description": "Bambu printer serial number (required to start a print unless start_print is false)."
},
"api_key": {
"type": "string",
"description": "OctoPrint API key (Settings -> API)."
},
"dry_run": {
"type": "boolean",
"description": "Validate connectivity/auth only; never uploads or starts a print."
},
"printer": {
"enum": [
"generic-fdm",
"bambu-a1-mini",
"bambu-a1",
"bambu-p1s",
"bambu-p1p",
"bambu-x1c",
"bambu-x1e",
"bambu-h2d",
"bambu-h2s",
"prusa-mini-plus",
"prusa-mk4s",
"prusa-core-one",
"prusa-xl",
"creality-ender-3-v3",
"creality-k1",
"creality-k1-max",
"creality-k2-plus",
"elegoo-neptune-4-pro",
"anycubic-kobra-3",
"voron-2.4-250",
"voron-2.4-300",
"voron-2.4-350",
"ultimaker-s5"
],
"type": "string",
"description": "Printer profile id; checked against protocol before upload. List them with 'kernelcad print printers'."
},
"filename": {
"type": "string",
"description": "Uploaded file name (default: 'kernelcad.gcode'; bambu-lan appends '.3mf')."
},
"protocol": {
"enum": [
"octoprint",
"moonraker",
"bambu-lan"
],
"type": "string"
},
"gcode_path": {
"type": "string",
"description": "Path to the .gcode file on disk."
},
"access_code": {
"type": "string",
"description": "Bambu LAN-mode access code (printer settings -> LAN Only Mode)."
},
"start_print": {
"type": "boolean",
"description": "Start the print immediately after upload (default: true)."
},
"model_3mf_path": {
"type": "string",
"description": "bambu-lan only: model .3mf from export format '3mf' to package the G-code into (the uploaded .gcode.3mf)."
}
}
}| Features to trace. Defaults to a single { label: "silhouette", kind: "silhouette" } when omitted. |
| imageUrl* | string | URL or path to the reference image. Supports file://, http(s)://, data:image/...;base64,..., or a bare filesystem path. Hosted server: pass an https:// URL, a data: URI, or "asset:<id>" from request_upload — not a path on your machine. |
| validate | string | Assumption-ledger strictness. `warn` (default) never blocks. `error` fails the call when any `missing` ledger fact (e.g. scale) is still open. |
| detectParts | boolean | Optional: use the configured vision model to detect labeled component boxes and return detectedParts plus a draftBom, normalized to the traced outline frame. |
| scaleAnchor | object | Pixel-to-real-world scale anchor: two measured points on the image. Absent -> the returned ledger's `scale` fact is `missing`. |
| maxWaypointsPerFeature | integer | Cap on waypoints per feature. Defaults to 12 (suitable for medium-inflection outlines). |
{
"type": "object",
"required": [
"imageUrl"
],
"properties": {
"hint": {
"type": "string",
"description": "Optional free-text hint forwarded to vision-LLM backends (e.g. \"a pair of eyewear; trace the upper brow only\")."
},
"intent": {
"type": "string",
"maxLength": 2000,
"description": "The user's request in one sentence, in the user's own words and language (e.g. 'M4 bracket for a 25 mm tube, print on Bambu A1'). Helps kernelCAD improve; leave out personal data."
},
"priors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"statement",
"value",
"confidence"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": [
"string",
"number",
"boolean",
"array",
"object"
]
},
"statement": {
"type": "string"
},
"confidence": {
"type": "number",
"maximum": 1,
"minimum": 0
}
}
},
"description": "Caller-supplied category-norm defaults (e.g. wall thickness) recorded verbatim as `assumed` ledger facts."
},
"backend": {
"enum": [
"opencv",
"vision-llm",
"hybrid",
"auto"
],
"type": "string",
"description": "Force a specific backend; default `auto` routes by corner-color stddev."
},
"features": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"kind"
],
"properties": {
"kind": {
"enum": [
"silhouette",
"curve",
"point",
"bbox"
],
"type": "string",
"description": "Geometric shape of the requested feature."
},
"label": {
"type": "string",
"description": "Caller-chosen identifier (echoed in the response)."
},
"region": {
"type": "string",
"description": "Optional free-text region hint forwarded to vision-LLM backends; ignored by opencv."
}
}
},
"description": "Features to trace. Defaults to a single { label: \"silhouette\", kind: \"silhouette\" } when omitted."
},
"imageUrl": {
"type": "string",
"description": "URL or path to the reference image. Supports file://, http(s)://, data:image/...;base64,..., or a bare filesystem path. Hosted server: pass an https:// URL, a data: URI, or \"asset:<id>\" from request_upload — not a path on your machine."
},
"validate": {
"enum": [
"warn",
"error"
],
"type": "string",
"description": "Assumption-ledger strictness. `warn` (default) never blocks. `error` fails the call when any `missing` ledger fact (e.g. scale) is still open."
},
"detectParts": {
"type": "boolean",
"description": "Optional: use the configured vision model to detect labeled component boxes and return detectedParts plus a draftBom, normalized to the traced outline frame."
},
"scaleAnchor": {
"type": "object",
"required": [
"pixelDistance",
"realDistance",
"unit"
],
"properties": {
"unit": {
"enum": [
"mm",
"cm",
"in"
],
"type": "string"
},
"realDistance": {
"type": "number",
"description": "The same distance in real-world units."
},
"pixelDistance": {
"type": "number",
"description": "Distance in pixels between the two measured points."
}
},
"description": "Pixel-to-real-world scale anchor: two measured points on the image. Absent -> the returned ledger's `scale` fact is `missing`."
},
"maxWaypointsPerFeature": {
"type": "integer",
"minimum": 2,
"description": "Cap on waypoints per feature. Defaults to 12 (suitable for medium-inflection outlines)."
}
}
}| Argument | Type | Description |
|---|---|---|
| dxf | string | check:'dfm-preflight' — path to a DXF file. |
| code | string | Inline kernelCAD script source (same checks as `file`). |
| file | string | Path to a .kcad.ts script (assembly/dfm/dfm-preflight/swept-collision/reachable/mounting-holes/load-capacity/static-hold/geometry-quality/edge-radius). Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project. |
| mode | string | check:'load-capacity' — 'beam' (default), 'stub', or 'fea' (solve the script's feaStudy: CalculiX + gmsh when installed, else the in-process voxel estimate). |
| pose | object | array | check:'static-hold' — explicit pose (joint name -> deg/mm) or array of poses; omit to sample a grid across the evaluated joint's range. |
| seed | object | check:'reachable' — numeric IK seed pose (joint name -> deg/mm). |
| check* | string | Which verification to run. |
| edges | object | array | string | check:'edge-radius' — EdgeQuery or @kc[...] edge ref(s); intersected with faces. Query near sorts, it does not filter. |
| faces | object | array | string | check:'edge-radius' — FaceQuery or @kc[...] face ref(s); includes incident edges and fillets on selected faces. |
| joint | string | check:'swept-collision' — joint to sweep; omit to sweep every declared joint. check:'static-hold' — joint to evaluate; omit to evaluate every joint with a declared actuator. |
| loads | object | check:'load-capacity' — partName -> { force?: [Fx,Fy,Fz] N, torque?: [Tx,Ty,Tz] N*m }. |
| parts | array | check:'edge-radius' — explicit assembly part names (default all). |
| range | array | check:'swept-collision' — [lower, upper, step] in joint-native units. |
| study | string | check:'load-capacity' mode:'fea' — feaStudy name (default: the last declared one). |
| refine | boolean | check:'load-capacity' mode:'fea' — one automatic finer pass (0.75x element size) when the stress is untrusted, inside the element budget (default true); false solves once at the study's meshSize. |
| vendor | string | check:'dfm-preflight' — vendor SKU (required for that check). |
| wheels | array | check:'body-likeness' — wheel centres + tire radii [{ center:[x,y,z], radius }]. |
| gravity | array | check:'static-hold' — gravity vector, m/s^2, world frame (default [0, 0, -9.81]). |
| service | string | check:'dfm-preflight' — service. |
| assembly | string | Assembly name; defaults to the first captured assembly. |
| heatmaps | boolean | check:'load-capacity' mode:'fea' — also render stress heatmap PNGs (default false). |
| material | string | check:'dfm-preflight' — material SKU (required for that check). |
| supports | object | check:'motion-load' — mechanicalJoint name -> support part names to use instead of the declared supports (compare with / without a bushing). |
| tip_link | string | check:'reachable' — end-effector part name (required for that check). |
| body_bbox | object | check:'body-likeness' — body AABB { min:[x,y,z], max:[x,y,z] } in mm. |
| fasteners | array | check:'fastener-installation' — explicit named stations; empty means no coverage. |
| featureId | string | check:'dfm-preflight' — FeatureId to scope to. |
| materials | object | check:'load-capacity' — partName -> material declaration. |
| mesh_size | number | check:'load-capacity' mode:'fea' — element size override, mm. |
| sample_ms | number | check:'motion-load' — timeline sample step, ms (default 20). Inertia peaks depend on it at keyframe velocity steps. |
| urdf_path | string | check:'urdf' — path to the .urdf file. |
| cabin_bbox | object | check:'body-likeness' — optional cabin/greenhouse AABB for automated cabin-aft. |
| directions | array | check:'assembly-path' — additional nonzero world-space removal vectors; normalized and deduplicated. |
| feature_id | string | check:'geometry-quality' — body feature to measure; defaults to script return. check:'edge-radius' — lowered feature; default the returned model. |
| length_axis | string | check:'body-likeness' — wheelbase axis (default 'x'). |
| motion_mode | string | check:'motion-load' — 'tracks' (default): along the animationView timeline with inertia; 'range': quasi-static grid over each driven joint's limits. |
| thicknessIn | number | check:'dfm-preflight' — material thickness in inches. |
| thicknessMm | number | check:'dfm-preflight' — material thickness in millimeters. |
| toleranceMm | number | check:'fastener-installation' — linear tolerance, default .05 mm. |
| motion_loads | array | check:'motion-load' — external forces: [{ part, point: [x,y,z] mm in the part's modeled frame, force: [Fx,Fy,Fz] N world, fromMs?, toMs? }]. |
| quasi_static | boolean | check:'motion-load' — drop velocity/acceleration terms (gravity and external loads only). |
| max_radius_mm | number | check:'edge-radius' — maximum fillet radius in mm; must be >= min_radius_mm. |
| min_radius_mm | number | check:'edge-radius' — minimum fillet radius in mm (does not imply sharp-edge prohibition). |
| prefer_solver | string | check:'reachable' — force the IK path ('auto' default). |
| range_samples | number | check:'static-hold' — grid density per evaluated joint when `pose` is omitted (default 9). check:'motion-load' motion_mode:'range' — grid points per joint (default 5). |
| series_points | number | check:'motion-load' — max torque-vs-time points per joint in the result (default 120; 0 omits the series). |
| asserted_plane | object | check:'geometry-quality' — optional required mirror plane in model coordinates; normal is normalized and must be nonzero. |
| max_iterations | number | check:'reachable' — numeric-path iteration cap. |
| refreshCatalog | boolean | check:'dfm-preflight' — force vendor catalog refresh. |
| require_stills | boolean | check:'body-likeness' — require still_verdicts (default true). |
| still_verdicts | array | check:'body-likeness' — agent ortho still checklist [{ code, passed, finding, view? }]. Required codes: side-body-over-wheels, side-cabin-aft, rear-haunch, ortho-proportions-vs-reference. |
| body_feature_id | string | check:'body-likeness' — FeatureId to read body AABB from when body_bbox omitted. |
| target_position | array | check:'reachable' — target [x, y, z] mm (world frame). |
| disassemblyOrder | boolean | check:'assembly-path' — iteratively remove freed parts and return removalOrder or stuckParts. |
| angleToleranceDeg | number | check:'fastener-installation' — axis tilt tolerance, default 1 degree. |
| mesh_deflection_mm | number | check:'geometry-quality' — absolute mesh deflection, defaults to tolerance/4; must be <= tolerance/2. |
| require_edge_break | string | check:'edge-radius' — prohibit sharp convex/external, concave/internal, or all edges. |
| target_orientation | array | check:'reachable' — target XYZ Euler angles in radians. |
| tiny_face_area_mm2 | number | check:'geometry-quality' — flag faces strictly below this absolute area; zero disables. |
| tiny_face_relative | number | check:'geometry-quality' — fraction of total BREP surface area, ORed with absolute threshold. |
| short_edge_length_mm | number | check:'geometry-quality' — flag edges strictly below this length; zero disables. |
| min_torque_margin_pct | number | check:'static-hold' — safety-margin floor as a percent of actuator capacity (default 20). |
| position_tolerance_mm | number | check:'reachable' — position tolerance in mm. |
| symmetry_tolerance_mm | number | check:'geometry-quality' — maximum sampled mirror-to-mesh distance, mm. |
| collision_tolerance_mm3 | number | check:'swept-collision' — BREP intersection volume tolerance (mm^3). |
| safety_factor_threshold | number | check:'load-capacity' — pass/fail safety-factor floor (default 1.5; mode 'fea': the study's minSafetyFactor when declared). |
| orientation_tolerance_rad | number | check:'reachable' — orientation tolerance in radians. |
{
"type": "object",
"required": [
"check"
],
"properties": {
"dxf": {
"type": "string",
"description": "check:'dfm-preflight' — path to a DXF file."
},
"code": {
"type": "string",
"description": "Inline kernelCAD script source (same checks as `file`)."
},
"file": {
"type": "string",
"description": "Path to a .kcad.ts script (assembly/dfm/dfm-preflight/swept-collision/reachable/mounting-holes/load-capacity/static-hold/geometry-quality/edge-radius). Hosted server: cannot read files from your machine — pass `code`, or `project:<slug>` for a saved project."
},
"mode": {
"enum": [
"stub",
"beam",
"fea"
],
"type": "string",
"description": "check:'load-capacity' — 'beam' (default), 'stub', or 'fea' (solve the script's feaStudy: CalculiX + gmsh when installed, else the in-process voxel estimate)."
},
"pose": {
"type": [
"object",
"array"
],
"description": "check:'static-hold' — explicit pose (joint name -> deg/mm) or array of poses; omit to sample a grid across the evaluated joint's range."
},
"seed": {
"type": "object",
"description": "check:'reachable' — numeric IK seed pose (joint name -> deg/mm)."
},
"check": {
"enum": [
"assembly",
"urdf",
"dfm",
"dfm-preflight",
"swept-collision",
"reachable",
"mounting-holes",
"load-capacity",
"static-hold",
"motion-load",
"body-likeness",
"fastener-installation",
"geometry-quality",
"assembly-path",
"edge-radius"
],
"type": "string",
"description": "Which verification to run."
},
"edges": {
"type": [
"object",
"array",
"string"
],
"description": "check:'edge-radius' — EdgeQuery or @kc[...] edge ref(s); intersected with faces. Query near sorts, it does not filter."
},
"faces": {
"type": [
"object",
"array",
"string"
],
"description": "check:'edge-radius' — FaceQuery or @kc[...] face ref(s); includes incident edges and fillets on selected faces."
},
"joint": {
"type": "string",
"description": "check:'swept-collision' — joint to sweep; omit to sweep every declared joint. check:'static-hold' — joint to evaluate; omit to evaluate every joint with a declared actuator."
},
"loads": {
"type": "object",
"description": "check:'load-capacity' — partName -> { force?: [Fx,Fy,Fz] N, torque?: [Tx,Ty,Tz] N*m }."
},
"parts": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "check:'edge-radius' — explicit assembly part names (default all).",
"uniqueItems": true
},
"range": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "check:'swept-collision' — [lower, upper, step] in joint-native units."
},
"study": {
"type": "string",
"description": "check:'load-capacity' mode:'fea' — feaStudy name (default: the last declared one)."
},
"refine": {
"type": "boolean",
"description": "check:'load-capacity' mode:'fea' — one automatic finer pass (0.75x element size) when the stress is untrusted, inside the element budget (default true); false solves once at the study's meshSize."
},
"vendor": {
"type": "string",
"description": "check:'dfm-preflight' — vendor SKU (required for that check)."
},
"wheels": {
"type": "array",
"items": {
"type": "object"
},
"description": "check:'body-likeness' — wheel centres + tire radii [{ center:[x,y,z], radius }]."
},
"gravity": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "check:'static-hold' — gravity vector, m/s^2, world frame (default [0, 0, -9.81])."
},
"service": {
"enum": [
"laser",
"cnc-router",
"waterjet",
"bending"
],
"type": "string",
"description": "check:'dfm-preflight' — service."
},
"assembly": {
"type": "string",
"description": "Assembly name; defaults to the first captured assembly."
},
"heatmaps": {
"type": "boolean",
"description": "check:'load-capacity' mode:'fea' — also render stress heatmap PNGs (default false)."
},
"material": {
"type": "string",
"description": "check:'dfm-preflight' — material SKU (required for that check)."
},
"supports": {
"type": "object",
"description": "check:'motion-load' — mechanicalJoint name -> support part names to use instead of the declared supports (compare with / without a bushing)."
},
"tip_link": {
"type": "string",
"description": "check:'reachable' — end-effector part name (required for that check)."
},
"body_bbox": {
"type": "object",
"description": "check:'body-likeness' — body AABB { min:[x,y,z], max:[x,y,z] } in mm."
},
"fasteners": {
"type": "array",
"items": {
"type": "object",
"required": [
"part",
"against"
],
"properties": {
"part": {
"type": "string",
"minLength": 1
},
"against": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"uniqueItems": true
},
"engagementPart": {
"type": "string",
"minLength": 1
},
"maxProtrusionMm": {
"type": "number",
"minimum": 0
},
"minEngagementMm": {
"type": "number",
"minimum": 0,
"description": "Declared geometric axial overlap minimum; no thread-strength claim."
}
},
"additionalProperties": false
},
"description": "check:'fastener-installation' — explicit named stations; empty means no coverage."
},
"featureId": {
"type": "string",
"description": "check:'dfm-preflight' — FeatureId to scope to."
},
"materials": {
"type": "object",
"description": "check:'load-capacity' — partName -> material declaration."
},
"mesh_size": {
"type": "number",
"description": "check:'load-capacity' mode:'fea' — element size override, mm."
},
"sample_ms": {
"type": "number",
"description": "check:'motion-load' — timeline sample step, ms (default 20). Inertia peaks depend on it at keyframe velocity steps."
},
"urdf_path": {
"type": "string",
"description": "check:'urdf' — path to the .urdf file."
},
"cabin_bbox": {
"type": "object",
"description": "check:'body-likeness' — optional cabin/greenhouse AABB for automated cabin-aft."
},
"directions": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"maxItems": 64,
"description": "check:'assembly-path' — additional nonzero world-space removal vectors; normalized and deduplicated."
},
"feature_id": {
"type": "string",
"description": "check:'geometry-quality' — body feature to measure; defaults to script return. check:'edge-radius' — lowered feature; default the returned model."
},
"length_axis": {
"enum": [
"x",
"y"
],
"type": "string",
"description": "check:'body-likeness' — wheelbase axis (default 'x')."
},
"motion_mode": {
"enum": [
"tracks",
"range"
],
"type": "string",
"description": "check:'motion-load' — 'tracks' (default): along the animationView timeline with inertia; 'range': quasi-static grid over each driven joint's limits."
},
"thicknessIn": {
"type": "number",
"description": "check:'dfm-preflight' — material thickness in inches."
},
"thicknessMm": {
"type": "number",
"description": "check:'dfm-preflight' — material thickness in millimeters."
},
"toleranceMm": {
"type": "number",
"minimum": 0,
"description": "check:'fastener-installation' — linear tolerance, default .05 mm."
},
"motion_loads": {
"type": "array",
"items": {
"type": "object",
"required": [
"part",
"point",
"force"
],
"properties": {
"part": {
"type": "string"
},
"toMs": {
"type": "number"
},
"force": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"point": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"fromMs": {
"type": "number"
}
}
},
"description": "check:'motion-load' — external forces: [{ part, point: [x,y,z] mm in the part's modeled frame, force: [Fx,Fy,Fz] N world, fromMs?, toMs? }]."
},
"quasi_static": {
"type": "boolean",
"description": "check:'motion-load' — drop velocity/acceleration terms (gravity and external loads only)."
},
"max_radius_mm": {
"type": "number",
"minimum": 0,
"description": "check:'edge-radius' — maximum fillet radius in mm; must be >= min_radius_mm."
},
"min_radius_mm": {
"type": "number",
"minimum": 0,
"description": "check:'edge-radius' — minimum fillet radius in mm (does not imply sharp-edge prohibition)."
},
"prefer_solver": {
"enum": [
"analytical",
"numeric",
"auto"
],
"type": "string",
"description": "check:'reachable' — force the IK path ('auto' default)."
},
"range_samples": {
"type": "number",
"description": "check:'static-hold' — grid density per evaluated joint when `pose` is omitted (default 9). check:'motion-load' motion_mode:'range' — grid points per joint (default 5)."
},
"series_points": {
"type": "number",
"description": "check:'motion-load' — max torque-vs-time points per joint in the result (default 120; 0 omits the series)."
},
"asserted_plane": {
"type": "object",
"required": [
"origin",
"normal"
],
"properties": {
"normal": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
},
"origin": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3
}
},
"description": "check:'geometry-quality' — optional required mirror plane in model coordinates; normal is normalized and must be nonzero.",
"additionalProperties": false
},
"max_iterations": {
"type": "number",
"description": "check:'reachable' — numeric-path iteration cap."
},
"refreshCatalog": {
"type": "boolean",
"description": "check:'dfm-preflight' — force vendor catalog refresh."
},
"require_stills": {
"type": "boolean",
"description": "check:'body-likeness' — require still_verdicts (default true)."
},
"still_verdicts": {
"type": "array",
"items": {
"type": "object"
},
"description": "check:'body-likeness' — agent ortho still checklist [{ code, passed, finding, view? }]. Required codes: side-body-over-wheels, side-cabin-aft, rear-haunch, ortho-proportions-vs-reference."
},
"body_feature_id": {
"type": "string",
"description": "check:'body-likeness' — FeatureId to read body AABB from when body_bbox omitted."
},
"target_position": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "check:'reachable' — target [x, y, z] mm (world frame)."
},
"disassemblyOrder": {
"type": "boolean",
"description": "check:'assembly-path' — iteratively remove freed parts and return removalOrder or stuckParts."
},
"angleToleranceDeg": {
"type": "number",
"maximum": 90,
"minimum": 0,
"description": "check:'fastener-installation' — axis tilt tolerance, default 1 degree."
},
"mesh_deflection_mm": {
"type": "number",
"minimum": 1e-7,
"description": "check:'geometry-quality' — absolute mesh deflection, defaults to tolerance/4; must be <= tolerance/2."
},
"require_edge_break": {
"enum": [
"external",
"internal",
"all"
],
"type": "string",
"description": "check:'edge-radius' — prohibit sharp convex/external, concave/internal, or all edges."
},
"target_orientation": {
"type": "array",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"description": "check:'reachable' — target XYZ Euler angles in radians."
},
"tiny_face_area_mm2": {
"type": "number",
"default": 0.01,
"minimum": 0,
"description": "check:'geometry-quality' — flag faces strictly below this absolute area; zero disables."
},
"tiny_face_relative": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": 0,
"description": "check:'geometry-quality' — fraction of total BREP surface area, ORed with absolute threshold."
},
"short_edge_length_mm": {
"type": "number",
"default": 0.1,
"minimum": 0,
"description": "check:'geometry-quality' — flag edges strictly below this length; zero disables."
},
"min_torque_margin_pct": {
"type": "number",
"description": "check:'static-hold' — safety-margin floor as a percent of actuator capacity (default 20)."
},
"position_tolerance_mm": {
"type": "number",
"description": "check:'reachable' — position tolerance in mm."
},
"symmetry_tolerance_mm": {
"type": "number",
"default": 0.05,
"minimum": 0.000001,
"description": "check:'geometry-quality' — maximum sampled mirror-to-mesh distance, mm."
},
"collision_tolerance_mm3": {
"type": "number",
"description": "check:'swept-collision' — BREP intersection volume tolerance (mm^3)."
},
"safety_factor_threshold": {
"type": "number",
"description": "check:'load-capacity' — pass/fail safety-factor floor (default 1.5; mode 'fea': the study's minSafetyFactor when declared)."
},
"orientation_tolerance_rad": {
"type": "number",
"description": "check:'reachable' — orientation tolerance in radians."
}
}
}