pio_debug_cmd

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does so thoroughly by explaining blocking semantics, timeout behavior, the fact that the target keeps running after timeout, the need to use interrupt, and the shape of the returned data. This is unusually transparent for a debug command 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 dense but every sentence earns its place: it opens with the core action, lists useful command examples, explains blocking and timeout behavior, and summarizes return fields. There is no filler or repetition, and the most important operational details are 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?

For a complex command-execution tool with no annotations, the description covers invocation semantics, blocking behavior, timeout handling, interrupt path, and return data. The presence of an output schema further reduces the need to detail return structures, though the description still summarizes them helpfully. Nothing essential for correct invocation is missing.

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 0% and the schema only provides titles. The description richly explains the 'command' parameter through examples and semantics, and mentions timeout_s behavior. However, session_id is not explicitly described, though its name makes it reasonably inferable. The description compensates for most but not all of the missing schema detail.

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 states a specific verb and resource: sends one gdb command to an open debug session and returns parsed output. It clearly distinguishes itself from sibling tools like pio_debug_start, pio_debug_stop, and pio_debug_list by focusing on command execution within an existing session.

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 provides concrete command examples and explains when execution commands block, what happens on timeout, and how to halt a running target. It does not explicitly name alternatives or say when NOT to use this tool, but the usage context is clear enough for an agent to select it appropriately.

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