Insert an instance
onshape_insert_instanceInserts a part, whole Part Studio, or assembly into an assembly, with optional version selection for cross-document inserts.
Instructions
Insert a part, a whole Part Studio or another assembly into an assembly. Insert from a version when pulling from a different document.
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": {
"doc": "<doc>",
"ws": "<ws>",
"elem": "<elem>",
"src_elem": "<src_elem>"
},
"name": "onshape_insert_instance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ws | Yes | Workspace id — the <ws> segment of the document URL. | |
| doc | Yes | Document id — the <doc> in cad.onshape.com/documents/<doc>/w/<ws>/e/<elem>. | |
| elem | Yes | Element id (tab) — the <elem> segment of the document URL. | |
| part | No | Part id, to insert a single part. | |
| src_doc | No | Source document id (defaults to the target document). | |
| src_elem | Yes | Element id of the source Part Studio or assembly. | |
| is_assembly | No | The source element is an assembly. | |
| src_version | No | Source version id, required when inserting across documents. | |
| whole_studio | No | Insert every part of the source Part Studio. | |
| configuration | No | Encoded configuration for the inserted element. |