Skip to main content
Glama
freecad-mcp-headless

freecad-mcp-headless

by pitbuild

export_document

Exports FreeCAD document geometry to STEP, IGES, BREP, STL, OBJ, 3MF, DXF, SVG, AMF, or FCStd, inferring the format from the file extension and returning the written path, format, and byte size.

Instructions

Export the document geometry to STEP, IGES, BREP, STL, OBJ, 3MF, DXF, SVG, AMF or FCStd.

The format is inferred from the file extension unless format is given. Returns the written path, format and byte size.

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": {
      "path": "<path>"
    },
    "name": "export_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
formatNo
documentNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations at all, the description carries the full burden: it does disclose the return shape (written path, format and byte size), which is meaningful context. It does not say whether the file is overwritten if it exists, whether a document must already be open, or whether non-geometry data (parameters, history) is excluded from the export — all material for a filesystem-writing operation.

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?

Two short sentences: the capability and format list first, then the format-resolution rule and the return contract. The format enumeration is long but functional since those values are otherwise unavailable; almost nothing is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers the format vocabulary and the return values, offsetting the absent output schema. Against a 0%-coverage schema with three parameters and no annotations, however, the unexplained `document` argument and the silence on overwrite/permission behaviour leave gaps an agent would want closed before invoking a file-writing export.

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 0%, so the description must compensate: it does so for `format` by enumerating the ten accepted values and by explaining the extension-inference default, which the untyped anyOf schema does not convey. The `document` parameter (default null) is never mentioned, so one of three parameters remains completely unexplained in both schema and description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Export) and resource (document geometry) and enumerates the produced file formats, so the agent knows exactly what the tool yields. It does not contrast itself with near neighbours like save_document, which also writes to disk, so the reader must infer the difference between 'save a document file' and 'export geometry to a foreign format'.

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 sentence 'The format is inferred from the file extension unless ``format`` is given' gives a concrete selection rule for how to drive the tool, which is useful usage guidance. However, there is no explicit statement of when to prefer this over save_document or how it relates to close_document/open_document flows, leaving the when-to-use decision implied.

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