pyocd_flash_verify

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

No annotations are provided, so the description carries full burden. It discloses read-only behavior ('Reads Flash and compares'), return values ('verified:true or first mismatch address'), and progress notifications to prevent timeouts. It does not mention side effects (none expected) or required permissions, which is acceptable for a read-only tool.

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 three sentences long: first sentence defines purpose, second details operation and supported formats, third mentions progress notifications. It is well-structured, front-loaded, and every sentence adds value without fluff.

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 two parameters, an output schema (mentioned), and no nested objects, the description covers all essential aspects: what it does, how it works, file formats, return type, and timeout prevention. It could mention that a pyocd session must be connected, but this is implied by the tool's context among sibling session tools.

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 coverage is 100%, and the description repeats the schema's parameter descriptions without adding new meaning. For example, base_address is described as 'Base address for .bin files (default: 0x00000000). Ignored for .hex/.elf' in both. The baseline score of 3 is appropriate.

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's purpose: 'Verify the target's Flash content matches a firmware file.' It specifies the action (verify), the resource (flash content), and explicitly differentiates from siblings like pyocd_flash_program (write) and pyocd_flash_erase (erase) by its read-only compare 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 description implies usage for verification after programming, but does not explicitly state when to use or not use this tool versus alternatives like pyocd_flash_program or pyocd_memory_read. It lacks direct guidance on prerequisites or exclusions.

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