Set pull request vote

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

With no annotations provided, the description must disclose behavioral traits. It mentions that it is a write operation and requires confirm=true, but does not explain the effect on existing votes, reversibility, error conditions, or what the response looks like. It also repeats the confirm requirement already in the schema, adding minimal new behavioral context.

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, focused sentence that front-loads the primary action and then states the key requirement. It is concise and avoids unnecessary detail, though it could benefit from a slightly more structured breakdown of the confirm requirement.

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 mutation tool with no output schema, the description covers the core action and the confirm requirement. However, it lacks details on behavior like overwriting a previous vote, idempotency, or error handling, which would be helpful given the absence of annotations. It is adequate but not comprehensive.

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 80% (four of five parameters have descriptions). The description adds the context that the vote is for the authenticated user, which helps interpret the vote parameter, but does not explain the enum values or provide additional semantics beyond what the schema already offers. The confirm=true requirement is redundant with the schema.

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 ('Set') and a clear resource ('the authenticated user's Azure DevOps pull request vote'), distinguishing it from sibling tools like complete_pull_request or request_pull_request_changes. It also scopes the action to the authenticated user, which is a distinct behavior.

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 states a precondition ('Requires write tools and confirm=true') but does not explicitly contrast it with alternatives like request_pull_request_changes or set_pull_request_auto_complete. It gives some guidance on when to use (for voting) but no when-not or alternative selection criteria.

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