pyocd_target_halt

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

No annotations present, so description must carry burden. It mentions 'immediately' and return of PC, but lacks details on side effects (e.g., CPU state changes, impact on breakpoints, or whether reconnection needed). Adequate but not comprehensive.

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?

Extremely concise: one sentence, front-loaded action and return. No filler words.

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 zero-parameter, simple tool with output schema present, the description is mostly complete. However, missing usage context (e.g., when to use vs wait_halt) slightly lowers completeness.

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?

No parameters in schema, so baseline is 4. Description adds no parameter info, but there is none to add. Schema coverage is 100%.

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 halts/pauses the target CPU immediately and returns the PC, with a specific verb and resource. It differentiates from sibling 'pyocd_target_wait_halt' by emphasizing immediate halt.

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?

No guidance on when to use this tool versus alternatives like pyocd_target_wait_halt, or prerequisites. The description is limited to what it does, not when it's appropriate.

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