List features
list_featuresRetrieves a Part Studio's ordered feature tree with IDs, types, suppression, health, and rollback index, helping locate features to update or delete and diagnose modeling errors.
Instructions
List the feature tree of a Part Studio in order: features with feature_id, name,
feature_type (newSketch, extrude, fillet, ...), suppressed and health status (OK / WARNING
/ ERROR), plus the rollback_index. Use it to find the feature_id that update_feature or
delete_feature needs, to see why a part looks wrong (an ERROR feature built no
geometry), or - with feature_id - to read one feature's full raw JSON as a template for
add_feature or to learn its parameter IDs. The modeling tools already return the health
of the feature they add, so do not call this after every step: Onshape limits this
endpoint per day (a free plan can hit a 429 with a many-hour wait after heavy polling).
Read-only. For the parts it produces use list_parts; for variables list_variables.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"document_id": "<document_id>",
"element_id": "<element_id>"
},
"name": "list_features"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| element_id | Yes | Element (tab) ID: the string after /e/ in the Onshape URL. Get it from get_document. | |
| feature_id | No | If set, return the full raw JSON of just this feature (useful as a template for add_feature or to see its parameter IDs for update_feature). | |
| document_id | Yes | Onshape document ID: the 24-character hex string after /documents/ in the document URL. Get it from list_documents. | |
| workspace_id | No | Workspace ID (the string after /w/ in the URL). Optional - defaults to the document's main workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||