approve_workflow_run

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

With no annotations provided, the description carries the full burden. It adds the context of awaiting fork-PR approval, but it doesn't disclose side effects, required permissions, or error behavior. The included documentation link helps but the description itself stays minimal.

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 a single, clearly front-loaded sentence plus a docs link. Every word earns its place and there is no redundancy or filler.

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 simple approval action with fully documented parameters, the description provides adequate context about the specific use case. It could mention the response format or permission prerequisites, but the docs link and clear purpose make it largely complete.

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 already covers all three parameters fully with descriptions. The tool description adds no additional parameter-level information, so it relies entirely on the schema, which is sufficient.

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 uses a specific verb ('Approve') with a clear resource ('workflow run') and a precise condition ('awaiting fork-PR approval'). It distinguishes from sibling tools like cancel_workflow_run and rerun_workflow_run by specifying the unique approval scenario.

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 clearly states when to use this tool: for workflow runs awaiting fork-PR approval. It implies not to use it for other run states, though it does not explicitly name alternative tools or list exclusions.

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