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

explain_freecad_error

Read-onlyIdempotent

Translates cryptic FreeCAD or OpenCASCADE error messages into beginner-friendly causes and fixes.

Instructions

Translate a cryptic FreeCAD/OpenCASCADE error message into beginner causes and fixes.

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": {
      "error_message": "<error_message>"
    },
    "name": "explain_freecad_error"
  }
}

Input Schema

NameRequiredDescriptionDefault
error_messageYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered structurally. The description adds the useful behavioral fact that the response is framed as beginner-level causes and fixes, but says nothing about coverage limits (e.g. unknown errors) or whether the answer is from a local knowledge base.

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?

One sentence, front-loaded with the verb and the input, ending with the payoff. Nothing is redundant and nothing needs to be skimmed past.

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?

For a single-parameter, read-only tool with an output schema that already documents return values, this is nearly complete. The only shortfall is the lack of any note on input formatting or on what happens with unrecognized messages.

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

Parameters3/5

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

Schema description coverage is 0% for the single parameter, so the description must carry the meaning. It implies the parameter is the raw error text but does not say whether it should be verbatim, trimmed, or include the stack/traceback — a meaningful gap for a free-text input.

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?

Uses a specific verb ('Translate') with a clearly bounded resource ('FreeCAD/OpenCASCADE error message') and names the output ('beginner causes and fixes'). No sibling in the list performs error explanation, so an agent can route here without ambiguity, though the description never states that distinction 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?

Usage is only implied: the agent is expected to infer 'call this when you hit an error you cannot interpret'. There is no explicit when-to-use trigger, no mention of pairing with get_console_output to obtain the raw message, and no exclusions.

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