List documents
list_documentsSearch Onshape documents by name and scope to retrieve document IDs, names, owners, and modification dates for opening or referencing a specific document.
Instructions
Find Onshape documents: returns each one's document_id (every other tool needs it),
name, modified_at and owner, newest first unless sort_by says otherwise. Start here when
the user names a document: search with query, narrow with scope (your own, created by
you, shared with you, recent, or public). To open one document and see its tabs use
get_document; to make a new one create_document. Read-only. A full page includes a
next_offset: pass it as offset for the next page.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_documents"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size (Onshape allows at most 20). | |
| query | No | Case-insensitive text to look for in document names. | |
| scope | No | Which documents to list. | mine |
| offset | No | Skip this many results (paging). | |
| sort_by | No | modified |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||