Skip to main content
Glama
Cod3Talk3r

freecad-mcp

by Cod3Talk3r

Create document

create_document

Create a new empty FreeCAD document in the controlled workspace, validating the document ID as a safe filename and saving it atomically for later geometry additions.

Instructions

Create a new empty FreeCAD document and save it atomically to the controlled workspace. The document_id is validated to be a safe filename (letters, digits, '.', '_', '-', max 64 chars). The document is stored under <workspace>/<document_id>.fcstd and its metadata revision is set to 1. Use create_box or create_cylinder to add geometry.

Input Schema

NameRequiredDescriptionDefault
paramsYes

Output Schema

NameRequiredDescriptionDefault
objectsYesList of objects with basic info.
all_validNoTrue if validate_document reports all OK.
document_idYesValidated document identifier.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the burden well: it discloses atomic persistence, filename validation rules, the exact storage path, and that the metadata revision is initialized to 1. It omits write-conflict semantics — whether an existing document_id is overwritten or rejected — which is the main remaining behavioral gap for a mutation tool.

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 tight sentences, front-loaded with the core action, followed by the validation/path contract and the sibling hand-off. Nothing is redundant or buried.

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?

An output schema exists, so return-value explanation is correctly omitted, and the description supplies the write semantics an agent needs before invoking. The missing piece is collision/overwrite behavior for an already-existing document_id, which matters for a creation tool.

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 reported as low, so the description usefully compensates: document_id must be safe-filename characters (letters, digits, '.', '_', '-') capped at 64 chars, and its effect on the storage path is spelled out. The optional workspace parameter is left to the schema, keeping this just short of full coverage.

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 ('Create a new empty FreeCAD document') along with scope (atomic save to the controlled workspace). The word 'empty' plus the pointer to create_box/create_cylinder makes it unmistakably distinct from the geometry-creating siblings.

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 closing sentence routes the agent: use create_box or create_cylinder to add geometry, implying this tool is the prerequisite container-creating step. It gives clear context but never states an explicit exclusion (e.g., what to do if the document already exists).

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