Skip to main content
Glama
hjbaard

SolidWorks-MCP

read_sketch

Read a sketch's lines, arcs, circles, splines, dimensions, construction geometry, and fully defined status in model coordinates (mm) to verify it before extrude/cut.

Instructions

Read a sketch of the current part back, e.g. one a person drew (a list_features name).

Gives its lines, arcs, circles and splines in MODEL coordinates (mm), construction geometry marked, its dimensions (for set_dimension) and whether it is fully defined: check a design against fixed points before building on it with extrude_sketch / cut_sketch.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.9.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses return contents (geometry types, MODEL coordinates in mm, construction geometry marking, dimensions, fully-defined status), but does not mention permissions, errors, or side-effect guarantees beyond the implication that 'read' is safe.

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?

Two compact sentences, front-loaded with the core purpose and then the return details. Every clause contributes useful return or usage information with no wasted wording.

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

Completeness4/5

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

No output schema exists, so the description must explain return values; it does so with geometry types, coordinate system, units, dimensions, and fully-defined status. Parameter validation and missing-sketch behavior remain implicit, keeping it from being fully complete for a no-annotation tool.

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 schema has 0% description coverage for the single required 'name' parameter. The description identifies it as a list_features name, which helps an agent source the value, but does not specify naming conventions, case sensitivity, or error behavior for invalid names.

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?

States a specific verb (read) and resource (sketch) and enumerates the returned entities: lines, arcs, circles, splines, dimensions, and fully-defined status. This clearly distinguishes it from siblings like list_features and list_dimensions.

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?

Explicitly says to check a design against fixed points before building on it with extrude_sketch / cut_sketch, and references list_features as the source of the sketch name. It does not state when not to use it or name an alternative for listing sketches without geometry.

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