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

partdesign_groove

Revolve a sketch around an axis to subtract material in PartDesign; configure angle, midplane, and reversal for undoable cuts.

Instructions

Revolve a Sketch around an axis to subtract/cut material in PartDesign (undoable).

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": {
      "sketch_name": "<sketch_name>"
    },
    "name": "partdesign_groove"
  }
}

Input Schema

NameRequiredDescriptionDefault
axisNoV_Axis
nameNo
angleNo
doc_nameNo
midplaneNo
reversedNo
sketch_nameYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=false, so the safety profile is supplied. The description adds real value beyond that by disclosing '(undoable)' and the cut/subtract nature of the operation, which the annotations do not convey. It still omits what is required for success (active body, sketch inside that body) and what the operation does to the existing feature tree.

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 filler; the core action and result come first. It is arguably under-sized for a 7-parameter CAD feature, but nothing in the text 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?

An output schema exists, so return values need not be explained, and annotations cover the safety profile. However, with 0% schema coverage across 7 parameters and a geometry-modifying operation, the description leaves too much unexplained — particularly angular extent and the midplane/reversed flags — to be complete for the tool's complexity.

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% and there are 7 parameters, so the description carries the full burden — but it only alludes to the sketch and axis. Angle, midplane, reversed, name and doc_name receive no meaning whatsoever, including the non-obvious geometry flags midplane and reversed, which materially change the cut.

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 result: 'Revolve a Sketch around an axis to subtract/cut material,' which implicitly separates it from the additive partdesign_revolution sibling by naming the subtraction semantics. It does not explicitly name that sibling, so the differentiation is implied rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'in PartDesign' and 'subtract/cut material' hints at context, but there is no explicit when-to-use, no prerequisite about an active body or a sketch belonging to that body, and no reference to alternatives such as partdesign_revolution or partdesign_loft. An agent must infer the conditions from the tool name alone.

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