Get document
get_documentDescribe an Onshape document's main workspace ID and every element tab—Part Studios, Assemblies, Drawings, imported files—with their element IDs and types, so you can identify and rename unclear tabs.
Instructions
Describe one document: its main workspace ID and every element (tab) in it - Part
Studios, Assemblies, Drawings, imported files - with their element IDs and types. A tab
flagged has_default_name still carries Onshape's placeholder name: rename it with rename
to say what it holds.
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>"
},
"name": "get_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 | |||