Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Tutorial: Hole Sketch

sketch_tutorial_simple_hole

Demonstrates a deprecated fixed sketch workflow by drawing a 5 mm circle at the origin on the Top plane, closing the sketch, and returning the suggested cut-extrude input for a hole.

Instructions

Deprecated: no replacement.

Demonstrate the sketch steps: draw a 5 mm circle at the origin on the Top plane and close the sketch.

It is a fixed example; for a real hole, use create_sketch, add_circle, exit_sketch and create_cut_extrude. Needs: an open part. Changes: adds a sketch with one circle. Returns: steps_completed, next_step (cut the hole with create_cut_extrude) and suggested_cut, that call's input.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sketch_tutorial_simple_hole"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare this is a non-read-only, non-idempotent, non-destructive operation. The description adds useful behavior beyond them: it requires an open part, adds a sketch containing one circle, and identifies the returned fields including next_step and suggested_cut.

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 front-loaded with the deprecation and fixed-example purpose, then uses compact labels for Needs, Changes, and Returns. It is efficient overall, though the return-value sentence is somewhat redundant given the output schema.

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

Completeness5/5

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

For a simple zero-parameter tutorial tool with annotations and an output schema, the description is complete: it covers deprecation, prerequisites, exact effect, return fields, and the correct alternative workflow.

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?

This tool has zero parameters, so there is no parameter meaning for the description to supplement. The baseline for no parameters is 4, and the description appropriately does not invent parameter details.

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 action and resource: it draws a fixed 5 mm circle at the origin on the Top plane and closes the sketch. It also distinguishes this tutorial tool from the real modeling workflow by naming create_sketch, add_circle, exit_sketch, and create_cut_extrude.

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?

It clearly says this is a fixed example and directs real-hole work to the proper sibling tools, plus it states the prerequisite 'an open part.' The 'Deprecated: no replacement' note is slightly in tension with the suggested alternatives, but the usage context is still clear.

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

Deploy Server

Other Tools