Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Flat Pattern

set_flat_pattern
Idempotent

Flatten a sheet-metal part to its cut blank or fold it back, returning bounding box dimensions to verify size and bend allowance before DXF export.

Instructions

Flatten a sheet-metal part to its blank, or fold it back, and measure it.

Flattened, bounding_box_mm is the blank to cut: check it against the part's size and the bend allowance before export_flat_pattern writes the DXF. Fold it back before adding more features. Needs: a sheet-metal part. Changes: unsuppresses (flat) or suppresses (folded) the Flat-Pattern feature. Returns: flat, feature and bounding_box_mm.

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": "set_flat_pattern"
  }
}

Input Schema

NameRequiredDescriptionDefault
input_dataNo`flat` is true (flatten); false folds the part back.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations only say readOnlyHint=false, idempotentHint=true, destructiveHint=false; the description adds the crucial detail that the Flat-Pattern feature is unsuppressed or suppressed, which is the real state change an agent must anticipate. It also flags the prerequisite and the measurement output. Minor deduction for restating return fields that the output schema already covers.

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?

Front-loaded with the action, then a compact Needs / Changes / Returns structure that maps cleanly onto what an agent needs before calling. No filler sentences and no restating of the tool name.

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 single-parameter, idempotent toggle on a feature tree, the definition supplies prerequisite, side effect, verification step, and downstream ordering — everything needed to invoke it correctly. An output schema exists, so the brief Returns line is a convenience rather than a burden.

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 description coverage is 100% and the single `flat` parameter is already documented as true=flatten / false=fold back. The description repeats that meaning without adding format, default, or edge-case nuance beyond the schema, so the baseline 3 applies.

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 first sentence names a specific verb pair (flatten / fold back), the resource (a sheet-metal part), and the secondary effect (measure it). It also implicitly separates itself from export_flat_pattern by framing itself as the step that must happen before the DXF is written.

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?

Gives clear sequencing context: check the blank against part size and bend allowance before export_flat_pattern writes the DXF, and fold back before adding more features. It also states the prerequisite (needs a sheet-metal part). It stops short of saying what to do when the part is not sheet-metal or how to recover from a failed fold, so no explicit when-not guidance.

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