Skip to main content
Glama

Add Gear

add_gear

Create an involute spur gear solid in FreeCAD by specifying teeth, module, height, pressure angle, and external or internal profile; optionally place it to build meshing gear pairs.

Instructions

Add an involute spur gear (FreeCAD's core involute generator), extruded to a solid.

teeth: tooth count (>= 3). module: mm (pitch diameter = module * teeth). height: extrusion thickness mm. pressure_angle: deg (default 20). external: True for an external gear; False for an internal/ring tooth profile. placement: optional [x, y, z] mm translation. Returns {handle, name, volume, pitch_radius, tip_radius, root_radius, teeth, module, external}. Two external gears MESH when their axes are spaced (pitch_radius_a + pitch_radius_b) apart; phase one by half a tooth to avoid tooth-on-tooth interference.

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": {
      "teeth": "<teeth>",
      "module": "<module>"
    },
    "name": "add_gear"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoGear
teethYes
heightNo
moduleYes
externalNo
placementNo
workspaceNoRun this call in this named workspace
pressure_angleNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=false), so the description's extra value is the parametric constraint (teeth >= 3), the pitch-diameter formula tying module to geometry, and the listed return handle. It does not mention failure modes (e.g. what happens on invalid module or teeth < 3) or which document/body it attaches to.

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?

Front-loaded with the one-line statement of what is built, then a compact per-parameter block, then the return shape, then the meshing tip. Every line adds information; there is no filler or repetition of the title.

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?

No output schema exists, and the description supplies the returned fields (handle, name, volume, radii, teeth, module, external), which is what the agent needs. It is a bit thin on the calling context — which document or active workspace receives the gear is unaddressed — but for a single-solid creation call it is otherwise sufficient.

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

Parameters5/5

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

With schema description coverage at only 13%, the description carries the burden and does: teeth (with the >= 3 constraint), module (mm, with pitch diameter = module * teeth), height (extrusion thickness mm), pressure_angle (deg, default 20), external (True/False semantics for ring profile), placement ([x,y,z] mm). Only name and workspace are left to the schema, and workspace is documented there.

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: 'Add an involute spur gear ... extruded to a solid', and the parenthetical identifies the exact generator. That distinguishes it from the sibling gear-ish tools (add_rack, add_sprocket, add_pulley) without needing their schemas.

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?

Adds real selection context by describing how two external gears mesh (axes spaced pitch_radius_a + pitch_radius_b, phase by half a tooth), which tells the agent when this tool is the right one for a gear train. It never explicitly says when NOT to use it (e.g. vs add_rack for rack-and-pinion, or add_sprocket for chain drives), so it stops short of full exclusion guidance.

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

Deploy Server

Other Tools