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

Beyond the annotations it discloses non-obvious behavior: commits to a new branch, never merges, refuses pre-existing branches, returns 403 for unclaimed workspaces, and is labeled early access. It even notes the 'Early access' status, which annotations cannot express.

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?

Front-loaded with the core action, then behavior, then prerequisites. It is dense but every clause carries information; the only cost is a run-on second sentence packing multiple constraints together.

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 9-parameter mutation tool with no output schema, it covers prerequisites, side effects, and failure modes well. It stops short of saying what the call returns (PR URL/number), which an agent would want for chaining.

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 89%, so the schema already documents most parameters. The description only restates the branch and base defaults that the schema already gives, and explains nothing about payments/customers defaults or the framework enum beyond what is structured.

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?

States a concrete verb+resource ('Open ... as a pull request') and explicitly locates it relative to the sibling generate_monetization_code whose output it consumes, and to get_github_app_connection. An agent can distinguish it from other repo/commerce tools immediately.

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?

Gives explicit preconditions (billing write scope credential, App installed via get_github_app_connection, claimed workspace) and exclusions ('refuses a branch that exists', 'never merges', 403 on sandbox keys). When-to-use and when-it-will-fail are both spelled out.

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