oc_task_run_needs_help

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

Description adds context beyond annotations: 'non-terminal' constraint and 'secret-safe reason'. Annotations are silent on state changes; description reveals mutation (move to NEEDS_HELP). No contradiction, but no details on reversibility or permissions.

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?

Single 20-word sentence, front-loaded with action and target. No unnecessary words; every piece of information adds value.

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?

Covers overall purpose and parameter list, but lacks details on return values (no output schema), prerequisites (e.g., how to obtain run_id), and consequences of state change. Leaves some questions unanswered.

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 40%; description mentions all 5 params briefly ('secret-safe reason', 'optional resume hint, cursor, and evidence pointer'). Adds meaning beyond schema for 'reason' but leaves 'cursor' and 'hint' vague. Partially compensates for low schema 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?

Clear verb 'Move', specific resource 'non-terminal TaskRun', target state 'NEEDS_HELP', and lists parameters. Distinguishes from siblings like oc_task_run_complete by specifying the state transition.

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?

Implies usage when a task requires human help, but lacks explicit when-to-use or alternatives. Among many task-run tools, no guidance on when this is preferred over others.

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