Return the public tool catalog; research tools require explicit opt-in.

List thread standards from KOMPAS thread.db with helical-thread V1 compatibility hints.

List size rows of one thread standard table (d/p/title), with helical-thread-friendly shaping.

List only helical-thread-V1-compatible metric standards with bundled size rows.

Resolve a thread size by its designation/title within the default standard for a thread type (or an explicit standard).

Preview an end-view synchronous-belt pulley tooth profile; no CAD write.

Preview a cylindrical or explicitly crowned flat-belt pulley rim.

List ISO 9982:2021 PH, PJ, PK, PL, and PM Poly-V pulley profiles.

Resolve one ISO 9982:2021 Poly-V pulley groove profile.

Preview a rounded Poly-V pulley groove set without hubs, bores, or COM.

List built-in classical or narrow-wedge V-belt groove profiles.

Resolve one V-belt groove profile and its diameter-dependent angle.

Preview functional V-groove cut geometry without hubs, bores, or COM.

Preflight or cut previewed V-grooves into one global-X rotational body.

Preflight or cut exact rounded Poly-V grooves into one global-X rotational body.

Return basic information about the current KOMPAS session.

Return open KOMPAS documents.

Check whether a file can be opened and whether it appears locked by another process.

Open a KOMPAS document and return a stable document_id.

Close the selected or active document.

Close all tracked documents and release the KOMPAS session.

Open, save-as-close, reopen-readonly and close a KOMPAS document to verify lifecycle handling.

Save the selected or active document in place.

Save the selected or active document to an explicit path.

Save the active document to the default export directory with an ASCII-safe file name.

Check KOMPAS session/document readiness before running a low-level operation.

Read bounded active-document state through the primitive operation pipeline.

Capture a bounded readback snapshot for an active/opened document, optionally writing the full manifest JSON.

Compare two readback snapshot/manifest payloads or JSON artifact paths with bounded item deltas.

Verify expected before/after readback snapshot deltas for a primitive operation.

Capture two readback snapshots and verify that document readback is stable before write/read checks.

Classify a KOMPAS/COM runtime error into a stable code, category, and recovery hint.

Normalize a primitive operation result, preflight/readback checks, and optional error into one envelope.

Probe known sketch/feature collections exposed by the selected or active 3D document.

Collect a low-level COM readback manifest for an opened file or active document.

Probe formula-bearing sketch dimensions, constraints, and feature variables.

Preview a low-level section-by-surface operation payload.

Create a 3D point in the active part and verify the before/after snapshot delta.

Create a sketch with one 2D line segment and verify the before/after snapshot delta.

Create a sketch with one 2D circle and verify the before/after snapshot delta.

Create a sketch rectangle from two corners and verify the before/after snapshot delta.

Create one 2D sketch point in a new or existing sketch and verify the snapshot delta.

Create one 2D sketch polyline in a new or existing sketch and verify the snapshot delta.

Create one 2D sketch arc in a new or existing sketch and verify the snapshot delta.

Create one 2D sketch ellipse in a new or existing sketch and verify the snapshot delta.

Create several 2D sketch entities in one target sketch and verify the snapshot delta.

Apply constraints/dimensions to existing sketch entities selected by reference, index, or fingerprint.

List sketches with their stable sketch_ref values for follow-up entity tools.

Full dump of an existing sketch: entities, dimensions, constraints, status.

Parameters

document_id : str | None Document ID. None = active document. sketch_ref : str Sketch reference (name or reference ID). include_dimensions : bool If True, read dimensions with values and entity refs. include_constraints : bool If True, read constraints via API5 ksGetObjConstraints (22 types: horizontal, vertical, parallel, perpendicular, merge_points, tangent, fixed_length, concentricity, etc.). include_diagnostics : bool If True, include COM/API5 diagnostic blocks such as projection classification, variable surfaces, available properties, and begin-edit fallback data. max_items : int Max entities per collection.

Returns

dict with: entities — list of {kind, index, geometry, reference, constraints_state} geometry: segments get start/end; arcs get start/end/center/radius/direction; circles get center/radius; points get point coordinates. dimensions — dimensions.items plus api5.dimension_variable_name and linked variable Expression when available. constraints — constraints.items/api5_items/all_items/projection_items with owner_object/partner_object links. status — sketch definition status (0=not_defined, 1=under, 2=fully, 3=over) collections — entity collections metadata projection — per-entity projection classification and UI-like projection constraints when detected.

Rename an existing sketch selected by sketch_ref.

Set line style on one existing sketch entity selected by reference, index, or fingerprint.

Delete one existing sketch entity selected by reference, index, or fingerprint.

Update geometry for one existing point, segment, circle, or arc selected by reference, index, or fingerprint.

List existing sketch dimensions with reference, index, fingerprint, and placement fields.

Inspect one existing sketch dimension selected by reference, index, or fingerprint.

List existing sketch constraints with reference, index, fingerprint, and owner entity fields.

Inspect one existing sketch constraint selected by reference, index, or fingerprint.

Delete all constraints attached to one existing sketch entity.

Plan or apply a bounded repair scenario for one existing sketch.

List existing 3D features with reference, index, fingerprint, and state fields.

Inspect one existing 3D feature selected by reference, index, fingerprint, or name.

Plan or apply bounded repairs to existing 3D features: rename, suppress, or delete.

List existing sketch entities with reference, index, fingerprint, and geometry selectors.

Inspect one existing sketch entity selected by reference, index, or fingerprint.

Scan a folder or a single file for KOMPAS model files without opening KOMPAS.

Run lifecycle smoke-checks over a folder or explicit file list, continuing after per-file errors.

Open models read-only, run naming/spec quality checks, close each document and continue after errors.

Preview a parametric part scenario without creating a KOMPAS document.

Create a KOMPAS part from a supported parametric scenario such as stepped_shaft.

List available built-in spring size catalogs.

Validate built-in spring catalog metadata and optional previews.

Find spring catalog entries by type, size, class, or tag.

Recommend nearest spring catalog entries for target dimensions.

Resolve one spring catalog entry to generator-ready scenario params.

Preview a supported spring from one resolved catalog entry.

Create a supported spring from one resolved catalog entry.

Preview a compression spring scenario without creating a KOMPAS document.

Create a KOMPAS compression spring part from the supported compression_spring scenario.

Read the stored composition of an assembly file directly from the file itself.

Read the stored composition of the selected or active saved document.

List available specification descriptions for the selected or active document.

Read the active or selected specification description with its objects and columns.

Build a practical specification preview from the assembly tree.

Build a preview for a separate .spw specification document from the assembly tree.

columns maps row fields to .spw columns: field, column_type, block_number, column_number, skip_unit_value. column_preset can be default/base or engineering_comment_columns. Engineering fields require explicit opt-in.

Create a separate .spw specification document from the current model tree.

By default writes only position, designation, title, quantity, comment. Engineering fields are written only when mapped by columns and opted in.

Create a specification description and fill rows from the current assembly tree.

Preview edits for existing specification rows by object_id and standard fields.

Apply edits to existing specification rows by object_id and standard fields.

Build a safe preview of filling or syncing specification rows from the model tree.

Apply filling or syncing of specification rows from the model tree.

Recreate the active specification from the model and then apply safe autofill for supported fields.

Apply the current cleanup rules, export a working copy, and write a report next to it.

Find candidate component path updates by searching for matching filenames under a new root.

Preview persistent relinks by reading the Sources entry of an assembly file directly.

Preview relinks for a file assembly from an explicit mapping file.

Build a grouped actionable relink plan for an assembly file.

Build a grouped actionable relink plan from an explicit mapping file.

Preview relinks from an explicit old->new mapping file, useful when files were also renamed.

Build a grouped actionable relink plan for the selected or active document.

Build a grouped actionable relink plan for the selected or active document from a mapping file.

Apply component source-path relinks to the selected or active assembly.

Apply relinks to an assembly file through KOMPAS itself and save the result to the target path.

Preview and apply assembly relinks by matching component filenames under a new root.

Preview and apply assembly relinks from an explicit mapping file.

Preview and apply assembly relinks, then save a safe exported copy with a relink report.

Apply relinks from an explicit mapping file and save a safe exported copy with a report.

Preview and apply assembly relinks to a copied file through KOMPAS itself.

Apply relinks from an explicit mapping file to a copied assembly through KOMPAS itself.

Return the assembly/model tree for the selected or active document.

Return selected tree items with their current properties.

Return a practical properties snapshot for selected items.

Preview direct property edits for writable item fields.

Apply direct property edits for writable item fields.

Search items by text and optional kinds.

Analyze naming issues in the selected or active document.

Analyze basic specification issues in the selected or active document.

Build a safe preview of name and designation changes.

Apply a prepared changeset to writable fields only.