Skip to main content
Glama
dsh18235538266-crypto

onshape-mcp-codex

get_document_summary

Retrieve a comprehensive summary of an Onshape document, including all workspaces and elements.

Instructions

Get a comprehensive summary of a document including all workspaces and elements

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYesDocument ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of disclosing behavior. It indicates a read operation but does not clarify what a 'comprehensive summary' actually contains, whether it aggregates data, how large the response might be, or whether any side effects or limitations apply.

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?

The description is a single front-loaded sentence with no filler. It communicates the core purpose efficiently, though the word 'comprehensive' is vague and could be replaced with more specific detail without harming conciseness.

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

Completeness2/5

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

With no output schema and no annotations, the description should explain what the tool returns and how an agent should interpret the result. It only says 'comprehensive summary' and that workspaces and elements are included, leaving the exact return structure and meaningful distinctions from other getters unexplained.

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?

The input schema already provides 100% coverage by describing documentId as 'Document ID', so the baseline is 3. The description adds no additional meaning about the parameter, but none is really needed for such a simple single-parameter tool.

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?

The description clearly states the verb 'Get' and the resource 'comprehensive summary of a document', and adds scope with 'including all workspaces and elements'. It is understandable and distinct from a plain document fetch, though it does not explicitly differentiate it from sibling tools like get_document or get_elements.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus alternatives such as get_document, get_elements, or list_documents. The description does not mention scenarios, exclusions, or relationships to sibling tools, so an agent must infer when this summary is the right choice.

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