Skip to main content
Glama
Sign In
FreeCAD Tutor MCP

FreeCAD Tutor MCP

by alex-r-t
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

highlight_ui_element

Read-onlyIdempotent

Temporarily spotlights a FreeCAD button, menu, panel, or workbench selector so users can locate and follow modeling steps. Optionally adds a short callout and auto-dismisses.

Instructions

Put a temporary, click-through visual spotlight on a FreeCAD button, menu, panel, or workbench selector.

Args: target: Command name (e.g. 'PartDesign_Pad'), button label ('Pad'), or panel name ('Model', 'Tasks', 'Report view', 'Workbench'). label: Optional short callout text shown next to the highlight frame. duration_s: Auto-dismiss time in seconds (1.0-20.0). clear: Set True to immediately remove any active highlight.

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

Input Schema

NameRequiredDescriptionDefault
clearNo
labelNo
targetNo
duration_sNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.1/5.0
Behavior4/5

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

Beyond the annotations (readOnly, idempotent, non-destructive), the description adds genuinely new behavioral facts: the highlight is temporary, click-through (does not block input), auto-dismisses on a timer, and can be removed instantly via clear. The disclosed 1.0-20.0 second bounds on duration are useful operating context. It does not say what happens if the target is not found, which keeps it from a 5.

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?

A single front-loaded purpose sentence followed by a compact Args block; every line adds information the schema lacks. No redundancy, no filler.

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?

With an output schema present, the description does not need to explain return values, and it covers all four parameters plus the highlight's transient, click-through nature. The main residual gap is failure behavior — what occurs when target is empty, unmatched, or when no GUI is running — which matters for a tool that manipulates live UI state.

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?

Schema description coverage is 0%, so the description carries the full burden and does so thoroughly: it explains each of the four parameters, gives concrete example values for target ('PartDesign_Pad', 'Pad', 'Model', 'Tasks'), and states the valid numeric range for duration_s that the schema does not express. This is exactly the compensation the low coverage requires.

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 opens with a specific verb and resource: 'Put a temporary, click-through visual spotlight on a FreeCAD button, menu, panel, or workbench selector.' That is far more informative than the name alone and clearly separates it from discovery-style tools in the catalog. It stops short of naming an alternative such as find_ui_command, so it lands at 4 rather than 5.

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?

Use is strongly implied by the visual-guidance framing and by the 'clear' flag semantics, so an agent can infer this is for drawing the user's attention to an existing widget. However, there is no explicit statement of when to prefer this over locating a command with a sibling tool, nor any prerequisite context such as whether the target must already be visible.

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