pyocd_flash_program

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

No annotations, so description carries burden. Mentions progress notifications to prevent timeouts and ELF auto-attach behavior. Missing details on post-programming actions like reset or verification.

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?

Three focused sentences: one for main purpose, two for specific guidance. No redundant phrasing, front-loaded with core action.

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 2 params and existing schema, description covers key aspects but lacks prerequisites (session connected?) and what happens after programming (reset, verify). Sibling tools hint at needed workflow but description doesn't complete it.

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 covers both parameters fully. Description adds minor value by recommending .hex format for armclang, but doesn't expand on the erase parameter's effect.

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?

Clearly states it programs firmware files to target flash with specific formats (.hex/.bin/.elf/.axf). Distinguishes well from sibling tools like erase and verify.

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?

Provides format preference for armclang firmware and notes automatic ELF attachment. Could be more explicit about when to avoid this tool, but gives good context.

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