Skip to main content
Glama

console_read

Read-only

Passively capture console output for a set number of seconds to inspect boot banners, self-test prints, or HardFault traces. Read-only; silence often means wiring or baud-rate problems.

Instructions

Listen passively: capture everything the firmware prints on the console for the given number of seconds, sending nothing.

Use it to watch boot banners, self-test prints, or fault dumps
(HardFault traces appear here). Output lands in data.text; a fully
silent window is reported as "(console silent)" in the summary —
which for a just-reset board usually means wiring or baud-rate
trouble rather than a healthy quiet firmware. Read-only.

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.
secondsNoSeconds to listen passively, sending nothing; below 0.1 it is clamped up (typical 2.0). Large values block for that long.

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.1/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, and the description agrees ('Read-only') rather than contradicting. It adds real context beyond the annotation: large values block for that long, silent windows are reported as '(console silent)', and silence after reset usually indicates wiring or baud trouble. It stops short of describing the return shape in detail, relying on the output schema.

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?

The purpose is front-loaded in the first clause, and the diagostic aside on '(console silent)' earns its place. It is slightly verbose across three segments but no sentence is pure 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?

An output schema exists, so return-value documentation is not required, and the description covers timing, blocking, and failure interpretation adequately. The only minor gap is that it leans on the output schema for the exact data.text contract, which is acceptable here.

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%, so both parameters are already documented with defaults and clamping behavior. The description only loosely restates the 'seconds' semantics ('for the given number of seconds') and adds nothing new about 'board', 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 and resource ('capture everything the firmware prints on the console') and pins the passive/silent scope ('sending nothing'). This clearly separates it from the sibling console_send, which an agent can distinguish without opening either schema.

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?

Gives concrete usage contexts: watch boot banners, self-test prints, or fault dumps. It implies the alternative ('sending nothing') but never names console_send explicitly, so the routing guidance is clear rather than exhaustive.

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