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

get_sketch_diagnostics

Read-onlyIdempotent

Inspect a FreeCAD sketch for degrees of freedom, open vertices, and missing, conflicting, or redundant constraints, then surface tutor hints to guide fixes.

Instructions

Inspect Sketch DoF, OpenVertices, missing/conflicting/redundant constraints, and tutor hints.

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

Input Schema

NameRequiredDescriptionDefault
nameYes
doc_nameNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/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 elsewhere. The description adds the diagnostic content list, but says nothing about cost, whether it requires a recomputed document, or how failures (e.g. unknown sketch name) surface.

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?

One compact sentence, front-loaded with the verb and resource, with no filler. The comma-separated list of diagnostics is dense but readable; nothing 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 described, and the operation is simple. However, for a tool requiring a sketch identifier plus an optional document name, the omission of any parameter meaning leaves the definition short of what an agent needs to call it correctly.

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% for two parameters, so the description must compensate and does not. It never explains that 'name' identifies the target sketch or what 'doc_name' (default empty) is for — the distinction between a sketch name and its owning document is left entirely to guesswork.

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?

Specific verb 'Inspect' plus the resource 'Sketch' and an enumeration of exactly what is reported (DoF, OpenVertices, constraint problems, tutor hints). This clearly separates it from the sibling mutation tools create_sketch/edit_sketch, though it never names an alternative 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 mention of missing/conflicting/redundant constraints and tutor hints suggests it is a debugging/validation step for an existing sketch, but there is no statement of when to call it versus edit_sketch or get_selection, and no preconditions or exclusions.

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