Resume an agent

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

The description adds the authorization class 'board_or_agent' beyond annotations. However, it does not explain behavior changes (e.g., starting a run, state transitions) that complement the annotations.

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 very short with three lines, no redundant details. It is concise but could benefit from structured bullet points for parameters.

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 the existence of many sibling lifecycle operations, the description lacks context on agent state requirements and relationship to other tools. Output schema exists, but absence of use-case guidance makes it incomplete.

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 description provides no parameter information. Schema coverage is 50% (body has a weak description from schema), but the description fails to add any meaning or usage context for the 'id' parameter.

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 'Resume an agent' with a verb and resource. However, it does not differentiate this from similar lifecycle operations like 'wakeup' or 'pause', which are present among siblings.

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 is provided on when to use this tool versus alternatives (e.g., pc_post_agents_by_id_wakeup, pc_post_agents_by_id_pause). No prerequisites or state requirements are mentioned.

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