Skip to main content
Glama
onshape-jamcp

onshape-jamcp

List documents

list_documents
Read-only

Search 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

NameRequiredDescriptionDefault
limitNoPage size (Onshape allows at most 20).
queryNoCase-insensitive text to look for in document names.
scopeNoWhich documents to list.mine
offsetNoSkip this many results (paging).
sort_byNomodified

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"Page size."New value: +"Page size (Onshape allows at most 20)."
    • changedInput schema / properties / limit / maximum
      Previous value: -100New value: +20
  2. First observedv1.1.1

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already declare `readOnlyHint: true` and `openWorldHint: true`, and the description is consistent with both. Beyond the annotations, it discloses the default newest-first ordering, returned fields, and pagination behavior through `next_offset` and `offset`; it does not discuss authorization or rate limits, but those are less central here.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with purpose and scope, then moves to alternatives and paging without wasted text. Each sentence contributes either selection guidance, return information, or invocation mechanics.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only list tool with an output schema and mostly documented parameters, the description supplies the key context an agent needs: what is returned, how to search and narrow, how to page, and which sibling tools to use instead. Nothing important for correct selection or invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 80%, so the baseline is 3, but the description adds useful meaning by explaining `query` as a search mechanism and mapping the `scope` enum options to natural-language categories. It also explains the paging workflow between `next_offset` and `offset`, which goes beyond the schema's minimal descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: finding Onshape documents. It also names the returned fields and explicitly distinguishes itself from `get_document` and `create_document`, so an agent can identify its role without opening sibling schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit guidance to 'start here when the user names a document' and explains how to search and narrow results. It also names alternatives for opening a document (`get_document`) and creating one (`create_document`), covering when to use this tool versus related siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.