update_pull_request

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

No annotations provided, so description carries full burden. It only mentions 'Update' without explaining side effects, permissions, idempotency, or constraints (e.g., PR must be open). The term 'context resolution' for working_directory is vague.

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 concise, front-loading the main action in the first sentence, followed by a clear bullet list of arguments. No superfluous content.

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?

With 5 parameters and no annotations, the description explains each param but lacks details on return value, error conditions, or behavioral nuances (e.g., whether at least one of title/description must be provided). 'working_directory' remains ambiguous.

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 description coverage is 0%, so description compensates well: it explains each parameter's purpose, including the meaning of pr_url_or_id, optional title/description, working_directory for context, and work_item_ids for linking. However, could be more detailed on 'context resolution'.

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 it updates title and/or description of an existing PR, with a specific verb and resource. It distinguishes from sibling tools like create_pull_request, complete_pull_request, and set_pr_draft_status.

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 such as retarget_pull_request or set_pr_draft_status. The description lacks explicit context selection criteria.

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