Skip to main content
Glama

Register Handle

register_handle

Adds an existing FreeCAD object to AnkusDrive’s handle table, enabling later tool calls to reference it by handle after script runs or document opens.

Instructions

Register an existing FreeCAD object into the AnkusDrive handle table. Use after run_script (when auto_register=False) or after open_document to bring objects into the handle ecosystem so subsequent tool calls accept them via handle.

object: the FreeCAD object's .Name (e.g. 'Helix001', 'Cut'). prefix: handle prefix (default 'manual'). Each call returns a fresh handle; registering the same object twice produces two aliases. Returns {handle, name, type, label}.

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": {
      "object": "<object>"
    },
    "name": "register_handle"
  }
}

Input Schema

NameRequiredDescriptionDefault
objectYes
prefixNomanual
workspaceNoRun this call in this named workspace

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.6/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false), the description discloses a genuine behavioral trait: each call returns a fresh handle and registering the same object twice yields two aliases. It also documents the return shape, which matters since there is no output schema. Missing only things like whether the handle survives document reloads or session boundaries.

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 action and the sequencing rule, then per-parameter lines, then the return contract. No sentence is redundant and the whole thing is a handful of lines.

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?

Covers what an agent needs: why to call it, when to call it, the key parameter format, the duplicate-alias caveat, and the return fields in lieu of an output schema. The only gap is the workspace parameter's effect on the call.

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 only 33%, so the description must compensate, and it does for two of three parameters: 'object' is pinned to the FreeCAD .Name with concrete examples ('Helix001', 'Cut'), and 'prefix' is given both its default and its meaning. The 'workspace' parameter is not addressed in the description, though the schema carries a short note for it.

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 ('Register an existing FreeCAD object into the AnkusDrive handle table') and immediately explains the effect: objects become usable via handle by later tool calls. That distinguishes it from the many make_*/add_* siblings that create geometry rather than register existing objects.

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

Usage Guidelines5/5

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

Gives explicit trigger conditions: after run_script when auto_register=False, or after open_document. The agent knows exactly which upstream state calls for this tool rather than one of the make_* or get_object siblings.

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