Skip to main content
Glama

doctor

Read-only

Diagnose ST-Link probe visibility, serial port resolution, and cross-toolchain installation before board operations; report the exact missing prerequisite when flashing or build fails.

Instructions

Diagnose the bench: is the ST-Link probe visible, is the console serial port resolvable, is the cross toolchain installed?

Run this before anything else when a board operation fails — and
ALWAYS when a tool returns status "incomplete" or code
CAPABILITY_UNAVAILABLE; the report names the exact missing link.
Read-only. Findings are listed in data.log under "issues:"; an empty
problems list with exit_code 0 means every prerequisite is healthy.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardNoPath to the board profile YAML (e.g. boards/apollo-h743.yaml). Omit to use the server's --board argument, else the default search path.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeYes
dataNo
policyNo
statusYes
summaryYes
evidenceNo
warningsNo
exit_codeNo
schema_versionNo1.0

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true, and the description adds useful context about what the report contains (data.log with 'issues:' list, empty problems + exit_code 0 means healthy). It doesn't cover whether findings are re-runnable, timing, or side effects, but for a read-only diagnostic the disclosure is strong.

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?

Three sentences that are front-loaded with purpose, then usage conditions, then output interpretation. No filler, every clause carries information.

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 purpose, preconditions, and output semantics (issues list, exit code). With an output schema present and annotations covering safety, this is nearly complete. Could mention board profile precedence more clearly, but that's in the schema.

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 100%, and the parameter itself has a detailed description in the schema. The tool description adds no parameter-level information beyond what's in the schema, so baseline 3 is appropriate.

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 (diagnose) and a precise set of checks (ST-Link probe visibility, console serial resolvability, cross toolchain installed). This is clearly distinguishable from siblings like probe or board_info, which perform operations rather than environment diagnostics.

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?

Explicitly states when to run it: 'before anything else when a board operation fails' and 'ALWAYS when a tool returns status "incomplete" or code CAPABILITY_UNAVAILABLE'. It routes the agent to this tool in specific failure conditions, which is exactly what usage guidance should do.

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