Approve Pull Request

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

Annotations already indicate idempotency and non-destructiveness. The description adds that it returns 'Approval details' but does not elaborate on side effects (e.g., notifications, state changes) or behavior on duplicate approvals, which is acceptable given annotation coverage.

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 purpose followed by a clear arg list. No unnecessary words, front-loaded with the core action.

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?

Despite having output schema, the description only says 'Approval details' without specifics. It omits operational context like required permissions or workflow steps (e.g., review submission). Annotations cover safety, but completeness for a mutation tool could be improved.

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?

With 0% schema description coverage, the description compensates by listing and explaining each parameter (e.g., 'repo_slug: Repository slug', 'workspace: Workspace name (optional, defaults to configured workspace)'). It adds meaning beyond schema titles but lacks format hints or constraints.

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 'Approve a pull request.' clearly states the action and resource. It distinguishes from sibling tools like 'decline_pull_request', 'unapprove_pull_request', and 'request_changes_pull_request'.

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. No prerequisites (e.g., user must be a reviewer, PR must be open) or exclusions are mentioned, leaving the agent to infer context from the tool name alone.

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