Skip to main content
Glama
Cod3Talk3r

freecad-mcp

by Cod3Talk3r

Save document

save_document

Atomically save the current FreeCAD document by document ID, optionally within a workspace, and increment its metadata revision after a successful save.

Instructions

Explicitly save the current document atomically. This is equivalent to the auto-save that happens after create_box/create_cylinder/set_parameter, but can be called independently. After a successful save the document's metadata revision is incremented.

Input Schema

NameRequiredDescriptionDefault
paramsYes

Output Schema

NameRequiredDescriptionDefault
successYesWhether the export completed without error.
step_pathYesAbsolute path to the exported STEP file.
document_idYesValidated document identifier.
exported_countYesNumber of objects exported.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral burden and does well by disclosing atomicity, equivalence to auto-save, and that a successful save increments the document metadata revision. It omits failure behavior, permission requirements, and whether it overwrites unsaved changes, leaving some mutation semantics unclear.

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?

Three short sentences, front-loaded with the core action and followed by useful behavioral context. There is no wasted text and the key equivalence to auto-save is easy to extract.

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?

The output schema is present, so return values need not be described. The description covers the important save behavior and revision increment, though it could say more about error cases and the workspace parameter for a mutation tool with no annotations.

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

Parameters2/5

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

The description refers only to the 'current document' and does not explain the document_id or workspace parameters. With the context signal indicating low schema description coverage, the description should compensate but does not add meaningful parameter semantics.

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: explicitly saving the current document atomically. It also distinguishes this from the automatic saves triggered by create_box/create_cylinder/set_parameter, so an agent can tell it apart from sibling mutation tools.

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 clearly explains that this is equivalent to auto-save but can be called independently, giving a usable context for when to invoke it. It does not explicitly say when not to call it or name an alternative explicit-save path, so it falls short of a 5.

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