Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Update Sheet Format

update_sheet_format
Idempotent

Change an active SolidWorks drawing sheet's format and paper size while keeping all views and title block values intact. Specify a format name or .slddrt path; size is read from the name unless set.

Instructions

Change the active drawing sheet's format and paper size, keeping every view.

Give a format name SolidWorks has (e.g. "a2 - iso") or a .slddrt path; the paper size comes from the name unless given. The views are checked to be the same afterwards, and the title block keeps its values (they are properties). Needs: an open, active drawing. Changes: the sheet's format and size. Returns: sheet with sheet_format (the path), paper_size, sheet_mm and views.

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

Input Schema

NameRequiredDescriptionDefault
input_dataYesThe format. `sheet_format` is required; `paper_size` optional.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false), the description discloses what is preserved and verified: views are checked to remain identical and title-block values survive because they are properties. That meaningfully explains why the operation is non-destructive and idempotent, though it says nothing about required permissions or failure modes for invalid format names.

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?

Verb-plus-resource leads, then a compact block of labelled clauses ('Needs:', 'Changes:', 'Returns:') that an agent can scan quickly. Every clause carries information; there is no filler.

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 mutation on a drawing sheet, the description covers purpose, preconditions, preservation guarantees and even a summary of the returned `sheet` payload. Despite an output schema existing, the return summary is brief enough to aid selection rather than bloat.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: format can be a SolidWorks format name or a .slddrt path, and paper_size is inferred from the format name when omitted. That clarifies the interaction between the two nested properties beyond the schema text.

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 opening sentence names a specific verb and resource ('Change the active drawing sheet's format and paper size') and adds a scope guarantee ('keeping every view'). That distinguishes it from adjacent sheet tools like set_sheet_scale or update_title_block without needing to open the schema.

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 gives clear preconditions ('Needs: an open, active drawing') and explains how to supply the target ('a format name SolidWorks has (e.g. "a2 - iso") or a .slddrt path'). It stops short of stating when not to use it or pointing at a sibling for related sheet changes.

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