Skip to main content
Glama

board_info

Read-only

Discover the active board profile before building or flashing firmware—get board name, MCU, firmware directory, flash connection, and available probes.

Instructions

Discover what hardware you are working with: the active board profile.

Call this FIRST in any session — it tells you the board identity
(name, MCU), where the firmware builds (firmware_dir, artifact), how
it flashes (flash connection), and — most importantly — which
functional probes exist (the "probes" list holds the names the probe
tool accepts). Read-only; touches neither host nor board.

Result: data carries the full profile; warnings flag an unloadable
probes section (fix the board YAML before relying on probes).

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

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

Annotations only supply readOnlyHint, and the description reinforces that with 'Read-only; touches neither host nor board.' More valuably, it discloses failure semantics that annotations cannot express: warnings flag an unloadable probes section and the caller must fix the board YAML before trusting probes. That is real behavioral context beyond the structured fields.

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-loaded with the purpose and the call-first directive, and the result paragraph is tightly packed. The parenthetical emphasis ('most importantly') is slightly editorializing, but no sentence is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description need not enumerate return fields, yet it still summarizes the data/warnings split so the agent knows how to interpret results. Purpose, ordering, safety, and failure handling are all covered for a single-parameter read tool.

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 single 'board' parameter is fully documented there, including the omit-to-use-server-argument fallback. The description adds no syntax, format, or precedence detail for the parameter, so the baseline 3 applies.

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 ('Discover what hardware you are working with: the active board profile') and enumerates the concrete payload (name, MCU, firmware_dir, artifact, flash connection, probes). An agent can distinguish it from siblings like doctor, build, and flash without opening a 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 explicit ordering guidance ('Call this FIRST in any session') and cross-references the probe tool by noting the probes list holds the names probe accepts. It does not, however, state any condition under which you should skip it or name an alternative to use instead, so it stops short of full when/when-not coverage.

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