verify_flash

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

No annotations are provided, so the description carries the full burden of explaining behavior. It only restates that the tool verifies firmware against an image; it does not disclose whether the operation is read-only, whether a probe connection is required, how mismatches are reported, or what side effects might occur.

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, front-loaded sentence with no wasted words. The core purpose is stated first, and the 'pyocd verify' reference adds useful context without bloating the text.

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?

With three parameters, no output schema, and no annotations, the description is too thin. It does not explain return values, failure behavior, timeout semantics, prerequisites like probe connection, or how the image file should be referenced, leaving critical details to the agent's assumptions.

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%, but the description only adds minimal meaning to the 'image' parameter by saying verification is done against it. It provides no clarification for 'probe_id' or 'timeout_seconds', such as how probe selection works or what the timeout controls.

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 uses a specific verb, 'Verify', names the resource ('firmware on chip'), and specifies the comparison target ('an image'). It clearly separates this tool from siblings like flash_firmware and erase_flash, and the parenthetical 'pyocd verify' reinforces the exact operation.

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 tool is clearly meant to confirm that flashed firmware matches an image, so usage is implied, but there is no explicit statement about when to use it versus alternatives like flash_firmware or when not to use it. The description leaves the agent to infer the appropriate workflow context.

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