pio_coredump

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

With no annotations, the description provides significant transparency: it explains the analyzer dependency, the fallback behavior (erased partition, missing analyzer), and the prerequisite to stop monitors. It also implies the need for gdb and firmware.elf, which is valuable context beyond the schema.

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?

The description is a single block, but it is information-dense and front-loads the primary function. It adds the analyzer behavior and error cases, which is necessary but could be slightly streamlined. No redundancy, and each sentence contributes to understanding.

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?

Given the tool's complexity (flash reading, optional analysis, error states) and output schema, the description covers the key steps and edge cases. It doesn't specify return format, but the output schema likely handles that. It covers prerequisites and failure modes, making it adequate for an agent to execute correctly.

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?

Schema description coverage is 0%, so the description must compensate for parameter documentation. It mentions the analyzer and firmware.elf, which relates to the 'analyze' parameter, and the port is referenced via the monitor session. However, it doesn't detail 'env', 'out_path', or 'project_dir' semantics, leaving some gaps. Still, it provides enough to infer usage.

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 states the tool extracts a core dump from a flash partition, with a specific verb (pull) and resource (coredump flash partition). It details both the base operation and optional analysis, and distinguishes it from siblings like pio_decode_backtrace and pio_monitor_read by mentioning crash context and analyzer usage.

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 gives clear context on when to use (after a crash), and includes a critical prerequisite: stopping monitor sessions on the port first. While it doesn't explicitly name alternatives, it differentiates itself by focusing on core dump extraction vs. decoding backtraces, which is implied by the steps.

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