stm32_read_memory

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

No annotations are present, so the description carries the full burden. It does disclose the output format (hex dump or binary file) and that it is a read operation, but does not explicitly state side effects, prerequisites like an active debug connection, or error behavior. The read-only nature is implied but not confirmed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, dense sentence that states purpose and output with no filler. Every word earns its place, and the key verb and resource are front-loaded.

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

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

The tool is moderately simple; the schema covers parameters, and the description covers the return type. However, it lacks operational context such as requiring a connection setup, addressing limitations, or interpretation of the hex dump. Since there is no output schema, a bit more detail would round out the picture.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema provides comprehensive descriptions for all four parameters (100% coverage), so the baseline is 3. The description adds no additional parameter-specific detail beyond what the schema already offers.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly defines the tool's role: reading memory/registers from an STM32 target and returning a hex dump or saving to a binary file. It uses a specific verb ('Read') and resource ('target MCU memory or register contents'), and distinguishes from sibling write/erase/flash tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for memory reads but does not explicitly state when to prefer this over alternatives like stm32_read_option_bytes or stm32_raw_cli. No exclusion criteria or context about prerequisites (e.g., established connection) is provided.

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