Skip to main content
Glama
dsh18235538266-crypto

onshape-mcp-codex

search_documents

Search Onshape CAD documents by name or description using a query string. Set an optional limit to control the number of results returned.

Instructions

Search for documents by name or description

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of results
queryYesSearch query string

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior2/5

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

There are no annotations, so the description must carry the full behavioral burden. It only says 'Search for documents by name or description' without disclosing whether it returns summaries or full documents, how matching works, whether results are paginated, or any other operational traits.

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 a single, front-loaded sentence with no filler or redundant content. Every word contributes to the tool's purpose, making it easy for an agent to process quickly.

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

Completeness3/5

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

For a simple two-parameter tool, the description is minimally viable: it tells the agent what to search and on which fields. However, it omits any mention of result format or matching behavior, and with no annotations or output schema, an agent may still be uncertain what the call returns.

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?

The schema already documents both parameters with 100% coverage, and the description adds value by clarifying that the query string applies to both 'name' and 'description' fields. The limit parameter remains self-explanatory, but the description meaningfully enriches the query semantics.

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 states a specific action ('Search') on a clear resource ('documents') with a defined scope ('by name or description'). This distinguishes it from siblings like list_documents or get_document, though it does not explicitly name the alternative tools.

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?

The description provides no guidance on when to use this tool versus list_documents, get_document, or get_document_summary. The usage context is only implied by the word 'search', so an agent gets no explicit help choosing among the many document-related siblings.

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