io.github.gpambrozio/onshape

Post a hand-written BTM feature payload to a Part Studio. The escape hatch for feature types this server has no dedicated tool for — read onshape_get_feature_specs first.

Post a hand-written assembly feature payload — the escape hatch for mate types with no tool here.

Lock several instances together without individual mates.

Mass, volume, centroid and inertia for a whole assembly.

Join two or more mate connectors with a mate: FASTENED, REVOLUTE, SLIDER, PLANAR, and so on.

Place an implicit mate connector on an instance by inference (CENTROID, TOP, ...). Its feature id is what onshape_assembly_mate then joins.

Report which Onshape credential is active, where it came from and whether it still works. Secrets are redacted.

Combine bodies: UNION, SUBTRACTION or INTERSECTION. Subtraction also needs the targets query.

Merge all modifiable solid bodies into one. The usual cleanup before exporting a single part.

Bevel the selected edges. Selection works exactly as for onshape_fillet.

Repeat geometry around an axis.

Add an assembly tab to a workspace.

Create a document. Free Onshape accounts may only create public documents, so pass public=true there. The result carries the new document id and its default workspace id.

Create a drawing of a part, Part Studio or assembly. The source must be referenced by version — call onshape_create_version first and pass its id as src_version.

Add a Feature Studio tab for custom FeatureScript.

Add a Part Studio tab to a workspace. The new element id is at result.response.id.

Add a sketch from a list of entities: lines, circles, rectangles and arcs. Use this when the single-shape sketch tools cannot express the profile. Close the profile if you intend to extrude it.

Snapshot the workspace as an immutable version. Do this before restructuring an existing design: it is the only way back to the previous state, and drawings must reference a version.

Move a document to the trash. This affects the whole document, not a single tab.

Delete one element (tab) from a workspace.

Remove one feature from the tree. Features added after it may fail to regenerate.

Remove one instance from an assembly by its occurrence node id.

Taper faces away from a neutral plane — the usual requirement for moulded or cast parts.

Turn configuration parameter values into the encoded string other tools accept as `configuration`.

Run a FeatureScript function against the Part Studio and return its decoded value. The general-purpose way to inspect geometry: 'function(context is Context, queries) { ... }'.

Export through Onshape's translation service: STEP, IGES, 3MF, PARASOLID, SOLIDWORKS and others. Slower than STL because the translation is queued server-side.

Export a drawing as PDF (or DWG/DXF) through the translation service.

Export the Part Studio as STL, for 3D printing. Measure the model before exporting it.

Extrude the closed regions of a sketch into a solid. op=NEW makes a body, ADD merges into existing bodies, REMOVE cuts them, INTERSECT keeps the overlap.

Round the selected edges. Name the edges with one of: edges (ids), query (FeatureScript), feature (every edge that feature made), all, or circular.

Circular edges, optionally only those matching a radius — the usual way to pick hole rims to fillet.

Deterministic ids of the edges a given feature created, evaluated by Onshape.

List the Part Studios in a workspace, optionally filtered by a substring of the name.

The assembly's instances, occurrences, mate features and mate connectors.

The mates, mate connectors and groups defined in an assembly, with their feature ids.

Bodies, faces and edges with their deterministic ids — the source for explicit edge selection.

The assembly's BOM table.

The configuration parameters an element exposes, with their ids and allowed values.

Read one document's metadata, including its default workspace id.

Document metadata plus every workspace and the elements (tabs) inside each — the fastest way to orient in an unfamiliar document and collect the ids other tools need.

The views placed on a drawing sheet.

Every edge of every solid body, with its deterministic id, owning body, type and radius (inches).

List the elements (tabs) in a workspace: Part Studios, assemblies, drawings, Feature Studios.

The parameter ids, enum names and defaults Onshape expects for every feature type in this Part Studio. Read this before hand-writing a payload for onshape_add_feature.

The FeatureScript source of a Feature Studio.

The feature specifications a Feature Studio defines, for calling its custom features.

The full feature tree with each feature's id, type, parameters and regeneration state. Large — prefer onshape_measure or onshape_get_parts when you only need the result of the tree.

Read the properties of an element, or of one part when part is given.

The parts a Part Studio produces, with part ids for export and assembly insertion.

Entities and solved geometry for every sketch in a Part Studio, or for one sketch.