Skip to main content
Glama
FreeCAD Tutor MCP
by alex-r-t

create_document

Create a new FreeCAD document for safe tutoring demos, defaulting to a Tutor_Demo scratch file and optionally setting a name or activating it.

Instructions

Create a new FreeCAD document (defaults to a safe 'Tutor_Demo' scratch file for demonstrations).

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

Input Schema

NameRequiredDescriptionDefault
nameNoTutor_Demo
activateNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=false, so the safety/mutation profile is already covered. The description adds only that creation defaults to a scratch file; it omits whether this requires a running FreeCAD instance, how multiple documents are handled, or what happens to the default name.

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?

A single front-loaded sentence with no wasted words. The parenthetical is the only detail, which makes the structure efficient but slightly thin.

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?

An output schema exists, so return values don't need explaining. Still, for a mutating tool with 0% parameter coverage, the missing explanation of 'activate' and session preconditions leaves meaningful gaps.

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?

Schema description coverage is 0%, so the description must explain both parameters. It only clarifies the default name ('Tutor_Demo' scratch file); the 'activate' boolean is left completely undocumented 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?

The description states a specific verb+resource: 'Create a new FreeCAD document', and adds a default scratch-file detail. An agent can distinguish this from open_document or close_document, though it doesn't explicitly name the alternatives.

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?

It implies use for starting a fresh document and hints at demo/tutorial scenarios via 'Tutor_Demo'. However, it never says when to prefer this over open_document, nor what preconditions apply (e.g., an active FreeCAD session or existing unsaved documents).

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