pyocd_flash_erase

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

No annotations are provided, so the description must carry full behavioral disclosure. It mentions sending progress notifications to prevent timeouts, which is helpful. However, it does not state that erasing is destructive, that chip erase takes longer, or any side effects. Basic transparency is present but incomplete.

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?

Two concise sentences: the first states the core purpose, the second adds an important behavioral note about progress notifications. No redundant words; every sentence adds value and is 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?

Given the tool's simplicity (one boolean parameter), the description is mostly complete. It mentions progress notifications, which is relevant for long operations. However, it does not explain the return type (though output schema likely covers that) or prerequisites like requiring a session. Still, it suffices for effective use.

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 has 100% coverage for the single parameter chip_erase, with clear description. The tool description adds no additional meaning beyond the schema, so baseline score applies. No extra value or clarification is provided.

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 'Erase the target flash memory' with specific verb and resource. Among siblings like pyocd_flash_program and pyocd_flash_verify, it uniquely identifies the erase operation, making it easy to distinguish.

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 lacks explicit guidance on when to use this tool versus alternatives, such as before programming or for cleanup. It does not mention prerequisites like an active session or when to choose chip vs sector erase, though the parameter schema provides that. Adequate but could be clearer.

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