Skip to main content
Glama
solidworks-mcp

solidworks-mcp

export_document

DestructiveIdempotent

Export the active SolidWorks document to exchange formats such as STEP, STL, PDF, or DXF, choosing a target directory or using configured defaults while leaving the open document unchanged.

Instructions

Exports the active document to exchange formats, next to the document or in 'directory'. Existing files with the same name are replaced.

formats: e.g. ["step", "stl"]; omit to use the formats set by the user in the configuration (STEP by default). Supported: step, stp, iges, igs, x_t, stl, 3mf, pdf, png, dxf, dwg (pdf, dxf and dwg for drawings). directory: absolute, or relative to the folder of the document; "{format}" is replaced by the format name. Omit to use the configured directory. Created if missing. Files are named after the document. The open document is left untouched.

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

Input Schema

NameRequiredDescriptionDefault
formatsNo
directoryNo

Output Schema

NameRequiredDescriptionDefault
resultYes

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 already flag destructiveHint=true and idempotentHint=true; the description earns credit by explaining exactly what is destroyed ('Existing files with the same name are replaced'), that missing directories are 'Created if missing', and that the source document itself is untouched. That is real behavioral context beyond the annotations, though permission requirements for writing to disk are unaddressed.

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?

Front-loaded with the core action and the overwrite warning, then organized into labeled lines for the two parameters, so it scans well. Slightly verbose in the format list, but every element (supported values, placeholders, defaults) is actionable rather than 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?

An output schema exists, so return values need not be explained, and the description covers overwrite semantics, directory creation, default resolution, and filename derivation. Nothing an agent needs to call this export correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description carries the full burden and does so: it enumerates supported format tokens and their default, and defines 'directory' as absolute or document-relative with a '{format}' substitution token. Naming conventions ('Files are named after the document') are also supplied, which the schema does not contain.

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?

States a specific verb and resource ('Exports the active document') plus a scope qualifier ('to exchange formats') and location options. It also implicitly separates itself from save_document by noting 'The open document is left untouched', so an agent can tell this is a file-conversion export rather than a persist-changes save.

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?

Gives clear default behavior for both omitted parameters ('omit to use the formats set by the user', 'Omit to use the configured directory'), which is genuinely useful invocation guidance. However, it never states when to prefer this over sibling save_document or export_flat_pattern, so routing between export/save paths is left to inference.

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