Skip to main content
Glama
LBurny
by LBurny

diagnose

Find out why CADPilot cannot reach FreeCAD by probing the RPC port, process, addon, and logs; works even when FreeCAD is down.

Instructions

Find out why CADPilot cannot reach FreeCAD; works while FreeCAD is down.

Probes the RPC port, the process, the addon install and its logs.

Args:
    host: FreeCAD host to probe; defaults to this server's --host.
    dismiss: Also close the modal dialog blocking every call (Cancel, nothing confirmed).

Reference: operation_help("diagnose").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNo
dismissNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.7.7

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare mutation (readOnlyHint=false), idempotent=false, and openWorldHint=true. The description adds genuinely useful behavioral context: the tool runs even when FreeCAD is unreachable, and 'dismiss' closes the blocking modal via Cancel with 'nothing confirmed'. That side-effect disclosure goes beyond the annotations.

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?

Front-loads the core purpose in the first clause, then what it probes, then per-parameter notes. The Args block and operation_help reference are well-structured; slight redundancy in phrasing but nothing wasteful.

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, return values need not be described, and the description covers both parameters plus the failure-state usage context. For a two-param diagnostic tool this is nearly complete; only explicit alternative routing is missing.

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 description coverage is 0%, so the description carries the full burden, and it does: host is explained as defaulting to the server's --host, and dismiss is explained as closing the modal dialog ('Cancel, nothing confirmed'). Both parameters gain meaning not present in the schema.

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+outcome ('Find out why CADPilot cannot reach FreeCAD') and enumerates exactly what it probes (RPC port, process, addon install, its logs). This is unambiguous and separable from siblings like inspect_freecad or get_addon_log, which address narrower concerns.

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?

Clearly frames the context: use it to diagnose unreachable FreeCAD, and it 'works while FreeCAD is down', which tells the agent it is safe to run in the failure state. It stops short of naming an explicit alternative or when-not-to-use condition, so it's clear but not fully routing.

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