Skip to main content
Glama
dsh18235538266-crypto

onshape-mcp-codex

list_sketches

Lists all sketches in a Part Studio, showing feature IDs, names, status, and entity/constraint counts to help select the right sketch for further inspection.

Instructions

List every sketch in a Part Studio with featureId, name, status, and entity / constraint counts. Use to pick the right sketch before drilling in with inspect_sketch.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
elementIdYesPart Studio element ID
documentIdYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the transparency burden. It discloses that the operation returns ALL sketches with specific diagnostic fields and implies a read-only list operation. It could add more detail about return formatting or status values, but for a non-destructive list tool the behavior is largely clear.

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 only two sentences with no wasted words. The core action and output are front-loaded, and the usage note is appended efficiently. Every sentence earns its place.

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?

There is no output schema and no annotations, so the description must cover both behavior and parameters. It explains what the tool returns and when to use it, but it does not compensate for the two undocumented required parameters or clarify return format, status semantics, or error conditions. Adequate for a simple list tool, but with clear gaps.

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

Parameters2/5

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

Schema description coverage is only 33%; only elementId has a description. The tool description adds no parameter-level guidance, so documentId and workspaceId remain effectively undocumented except by their names. The low schema coverage is not compensated in the description.

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: 'List every sketch in a Part Studio' and enumerates the returned fields (featureId, name, status, entity/constraint counts). It clearly differentiates from the sibling inspect_sketch by positioning this as the selection step.

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?

The description explicitly says when to use the tool: 'Use to pick the right sketch before drilling in with inspect_sketch.' It names the related sibling and provides a clear decision context, leaving no ambiguity about its role in the workflow.

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