flash_and_run

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

No annotations are provided, so the description carries the full burden. It discloses the four-step process (flash, reset, set breakpoint, run to breakpoint) and the behavior of the 'break_at' parameter (skip if empty). It mentions returning 'Step-by-step execution results', but does not detail potential side effects (e.g., data loss from flashing) or permissions needed. Overall, it is mostly transparent but lacks some safety context.

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 concise and well-structured: a one-line summary, bulleted step list, and separate Args/Returns sections. Every sentence adds value. The format is front-loaded with the core purpose, and the steps are easy to parse. No unnecessary content.

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 that there is only one optional parameter and an output schema exists (covering return format), the description is mostly complete. It explains the composite operation and parameter behavior. However, it does not cover prerequisites (e.g., target must be connected, firmware file must be configured) or error scenarios. Still, for a simple tool with good schema support, it is adequate.

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 provides only type, title, and default for 'break_at'. The description adds critical semantics: it clarifies that the parameter is a symbol to break at, explains the default 'main', and states that setting it empty skips the breakpoint step. This information is essential for correct usage and goes well beyond the schema, compensating for the 0% schema description coverage.

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: 'Flash firmware to target and run to a breakpoint (default: main).' It breaks down the composite operation into four explicit steps, which distinguishes it from sibling tools that handle individual operations (e.g., 'reset', 'go', 'set_breakpoint'). The verb 'flash and run' plus the step enumeration leaves no ambiguity.

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 when you want to flash firmware and immediately run to a breakpoint, but it does not explicitly state when to use this versus alternatives like executing separate flash and run commands. It lacks guidance on prerequisites (e.g., being connected) or when to avoid this tool (e.g., if you need to run without a breakpoint). The composite nature is mentioned but no comparative advice.

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