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

Annotations already flag destructiveHint=true and openWorldHint=true, so the description's job is to add context — and it does: it requires an admin key, describes the install_url handoff path, and characterizes the side effects (comments on PRs, checks attached to commits). It stops short of saying whether reconnecting overwrites an existing connection or how to detach one.

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 core statement is front-loaded, but the first sentence is a dense 40-word clause with nested dashes and parentheticals that takes effort to parse. The admin-key requirement lands last and arguably deserves earlier placement given it is a hard precondition.

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 mutating, open-world tool with no output schema, the description covers the main unknowns: auth level (admin key), the policy scope of effects, and the failure-recovery path via install_url. Missing only whether the call is idempotent and what the returned payload looks like beyond the install_url case.

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 100% and each parameter carries its own description, including the enum values, so the schema does the heavy lifting. The description reinforces what 'policy production' and 'policy all' mean in terms of observable outcomes but adds little syntax-level detail beyond that.

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 states a specific verb and resource ('Connect the GitHub repository an app is deployed from') and explains the downstream effect precisely: deploys trigger checks under the app's merge gate, with per-policy scope. It is clearly distinguishable from siblings like create_app, list_apps, or update_app.

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?

It gives an explicit re-invocation rule: when the GitHub App cannot see the repository, the answer carries install_url for an admin to open and the tool should be called again afterward. It also ties the policy parameter to when checks run, though it doesn't explicitly name sibling alternatives such as update_app for changing an already-connected repo.

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