Skip to main content
Glama

get_board_info

Retrieve board configuration facts from the active board YAML file, including target, MCU, probe family, and recovery policy. Returns a notice when no board ID is provided.

Instructions

Return the facts from the board config the session was opened with.

Reports the ``boards/<board>.yaml`` definition active for this session —
pyOCD target, MCU and probe family, recover policy, silicon-id expectation,
default UART baud, and the smoke-test read address. Returns a notice when
``connect`` was called without a ``board_id`` (raw-target mode), where these
facts were not loaded.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

The description discloses the return value contents and notably includes behavior when connect was called without a board_id (raw-target mode), providing a special case. Since annotations are absent, the description adequately covers behavioral expectations.

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?

Two sentences, the first clearly states the purpose, the second details contents and a special case. No wasted words, efficiently front-loaded.

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?

Given no parameters and an output schema, the description fully explains the tool's function and the exceptional case. It is complete for the tool's complexity.

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?

With zero parameters and 100% schema coverage, the baseline is 4. The description adds value by enumerating the facts returned (target, MCU, etc.), beyond what the empty schema provides.

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?

The description clearly states the tool returns board config facts, listing specific items like pyOCD target, MCU, recover policy, etc. It distinguishes itself from sibling tools (connect, read_memory, etc.) by focusing on configuration retrieval.

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 implied by describing what the tool does, but no explicit when-to-use or when-not-to-use guidance is provided. The context suggests it should be called after a session is opened, but alternatives are not discussed.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/JasonPeng2019/BYO-Firmware-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server