Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

flatten

Shows and unsuppresses the flat pattern of the active sheet metal part, returning the flat size with the largest dimension first and marking the document modified.

Instructions

Show the flat pattern of the active sheet metal part (unsuppress it). Returns the flat size, largest first. The document is marked modified. unflatten folds it up again.

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

Input Schema

NameRequiredDescriptionDefault
unitNomm, cm, m, inch or ft

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses that the flat pattern is unsuppressed, that the document is marked modified, and that the return value includes flat size ordered largest first. It does not cover edge cases such as already-flat documents or permission requirements, but the key side effects and return behavior are stated.

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?

The description is compact and front-loaded: purpose first, then return value, then side effect, then the inverse operation. Every sentence contributes useful information, and there is no redundant or filler 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?

For a simple one-parameter tool with no output schema and no annotations, the description covers purpose, side effects, return ordering, and the inverse operation. The only minor gap is that it does not elaborate on the unit parameter or failure conditions, but the schema covers the parameter and the core behavior is sufficiently complete.

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 single optional unit parameter is fully described in the schema with allowed values, so the schema does the parameter documentation work. The description adds no additional meaning about the unit parameter, which is acceptable given 100% schema coverage but does not exceed the baseline.

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 gives a specific verb and resource: showing the flat pattern of the active sheet metal part, with the concrete action of unsuppressing it. It also distinguishes this operation from its inverse by naming unflatten. An agent can tell what the tool does without inspecting 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?

The description makes the usage context clear by scoping the operation to the active sheet metal part, and it names unflatten as the inverse operation for folding back up. It does not explicitly state when not to use it, such as for non-sheet-metal parts, so it falls just short of fully explicit when/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