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

create_varset

Creates an undoable FreeCAD App::VarSet parametric variable table so you can define reusable variables for parametric models.

Instructions

Create a FreeCAD 1.0/1.1 App::VarSet parametric variable table (undoable).

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_varset"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoVarSet
doc_nameNo
variablesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare it is a non-read-only, non-destructive, non-idempotent, closed-world operation, so the safety profile is covered. The description usefully adds that the operation is undoable, which annotations do not express; however, it says nothing about behavior when doc_name is empty, what happens if a VarSet with the same name exists, or required auth/state.

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 sentence with no filler, front-loading the verb and object type. It is efficient but so short that the space saved is not reused to explain parameters.

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

Completeness2/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 described, but for a mutation tool with three fully undocumented parameters and no annotation-level explanation of document targeting, the description is too thin to let an agent call it correctly without guessing.

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% across three parameters, so the description must carry the load and does not. It never explains what name, doc_name (default empty string — which document does that target?), or variables (an arbitrary object array — what keys per entry?) should contain.

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 and resource: "Create a FreeCAD 1.0/1.1 App::VarSet parametric variable table." The version qualifier and the exact object type (App::VarSet) make it distinguishable from generic siblings like create_document or create_sketch, though it never names an alternative explicitly.

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 parenthetical "(undoable)" and the object type imply this is for adding a parametric variable container inside an existing model, but there is no explicit statement of when to use it versus creating a document or sketch, and no stated prerequisites (e.g., whether a document must be active, since doc_name defaults to empty).

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