Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Get document

get_document
Read-only

Describe 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

NameRequiredDescriptionDefault
document_idYesOnshape document ID: the 24-character hex string after /documents/ in the document URL. Get it from list_documents.
workspace_idNoWorkspace ID (the string after /w/ in the URL). Optional - defaults to the document's main workspace.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true and openWorldHint=true, so safety is covered; the description adds genuinely new behavior by stating that a has_default_name flag means Onshape's placeholder name is still in place. It does not mention permissions, rate limits, or whether elements from linked/imported documents are included, but for a read-only descriptor this is good coverage.

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

Conciseness4/5

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

Two front-loaded sentences: purpose first, then the rename hint. Every clause earns its place, though the parenthetical list of tab kinds ('Part Studios, Assemblies, Drawings, imported files') is slightly verbose and restates what the output schema likely conveys.

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 simple two-parameter read tool with full schema coverage, an output schema, and readOnly annotations, the description supplies everything needed: what is fetched, what the response contains at a high level, and what to do with the has_default_name signal.

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

Parameters3/5

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

Schema description coverage is 100%, with document_id format (24-char hex after /documents/) and workspace_id defaulting to the main workspace already documented in-schema. The description's mention of 'main workspace ID' clarifies the default behavior of workspace_id but is framed as a return field rather than parameter guidance, so it adds little beyond the schema.

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

Purpose4/5

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

States a specific verb ('Describe') and a precisely bounded resource ('one document'), then enumerates exactly what is returned: main workspace ID plus every element (tab) with element IDs and types. The singular 'one document' implicitly separates it from list_documents, but no sibling is named to make the distinction explicit.

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

Usage Guidelines4/5

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

Gives clear context for calling it (you want the internal structure of a single document) and an actionable follow-up rule: if a tab has has_default_name, use `rename` to fix the placeholder. It stops short of explicit exclusions such as 'use list_documents to find an ID first' or when not to fetch elements.

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