Skip to main content
Glama

device_config_read

Read-onlyIdempotent

Reads a board's full configuration file and returns its MD5 plus parsed JSON for verification against flashed settings; read-only.

Instructions

Read back the whole board config file (GET_FILE_INFO + every GET_FILE_BLOCK), trimmed to file_size, with its MD5 (compare with flash_config's md5) and the parsed config JSON. Read-only.

Input Schema

NameRequiredDescriptionDefault
device_idYesDevice identifier (bluetoothDeviceId) from device_list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent and non-destructive, so the bar is lower, and the description still adds real mechanism: the read is synthesized from one info call plus a call per block, and the result is trimmed to file_size. The 'Read-only.' closing restates the annotation rather than adding, but the aggregation cost and trimming behavior are genuinely useful disclosures.

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?

One dense sentence that front-loads the resource and the mechanism, followed by a short safety tag. No wasted hedging, though the parenthetical protocol-level detail is heavier than most readers need.

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?

There is no output schema, and the description compensates by naming the return contents (file_size-trimmed bytes, MD5, parsed config JSON). For a single-parameter read tool with full annotation coverage, that is essentially complete; only the multi-call cost/failure behavior is unstated.

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?

Only one parameter and schema coverage is 100%, with the schema itself documenting device_id as a bluetoothDeviceId from device_list. The description adds nothing about 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 (read back the whole board config file) plus exactly what it assembles: GET_FILE_INFO plus every GET_FILE_BLOCK, trimmed to file_size. By saying 'whole ... file' and referencing flash_config's md5, it distinguishes itself from the per-block sibling device_config_block and from device_config_get without the agent opening another schema.

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 rather than stated: 'compare with flash_config's md5' signals the verification workflow, but it never explicitly says when to choose this over device_config_block or device_config_get, nor when-not to use it. An agent can infer the whole-file use case but gets no explicit routing rule.

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