Get an Onshape document

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

The readOnlyHint annotation already establishes this as a safe read operation, and the description is consistent with that. It adds a small behavioral detail—returned metadata includes the default workspace id—but it does not disclose error behavior or authentication requirements; this is acceptable for a simple read annotated as read-only.

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

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

The description is one short sentence, front-loaded with the verb 'Read', and contains no filler or repeated information from the title.

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

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

This is a simple one-parameter read operation with a fully documented schema and a read-only annotation. The description is largely sufficient for invocation, though because there is no output schema, the return value is only vaguely described as 'metadata' plus one field.

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

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

The single required parameter 'doc' is already fully described in the schema with a URL template, so schema coverage is 100%. The description adds no additional parameter-level meaning, so the baseline of 3 applies.

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

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

The description states a specific action—'Read'—and a specific resource—'one document's metadata'—and adds a concrete returned field ('default workspace id'). It is clear enough, but it does not explicitly differentiate itself from the sibling onshape_get_document_summary.

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

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

No guidance is given on when to use this tool instead of list_documents, search_documents, or get_document_summary. The only hint is 'one document', which weakly implies a single-document lookup.

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