Skip to main content
Glama
Sign In
SolidworksMCP-python

SolidworksMCP-python

by andrewbartels1
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

tutorial_simple_hole

Guided tutorial to create a simple hole by sketching a circle on a plane and cutting to a given diameter and depth (through hole if depth omitted).

Instructions

Create a simple hole as a guided tutorial workflow.

Builds a sketch circle on the selected plane, exits the sketch, and creates a cut feature using the supplied diameter and depth. Useful as an end-to-end example of a basic subtractive feature.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "input_data": "<input_data>"
    },
    "name": "tutorial_simple_hole"
  }
}

Input Schema

NameRequiredDescriptionDefault
input_dataYesThe input data value.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries full burden. It transparently outlines the multi-step process (build sketch, exit, cut feature) and clarifies it is a guided tutorial workflow. However, it does not disclose prerequisites like needing an active document or plane validity.

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 sentences: first states purpose, second details steps. No wasted words, front-loaded with key information.

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?

Given low complexity and presence of output schema, the description sufficiently explains the tool's behavior and workflow. Could mention the need for a sketch plane or that it assumes a clean state, but overall adequate.

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?

Schema coverage is 100% with descriptive parameter descriptions (e.g., depth: 'None for through hole'). The description adds minimal value beyond schema (e.g., references 'supplied diameter and depth'), so baseline 3 is appropriate.

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 clearly states the tool creates a simple hole as a guided tutorial workflow, with specific steps (builds sketch circle, exits sketch, creates cut). It distinguishes itself from siblings like 'sketch_tutorial_simple_hole' by focusing on the end-to-end subtractive feature rather than just sketch operations.

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

Usage Guidelines3/5

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

The description mentions 'useful as an end-to-end example of a basic subtractive feature,' implying tutorial use, but does not explicitly state when not to use or contrast with alternatives like 'create_cut_extrude' which achieves similar results more directly.

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