get_pull_request

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

No annotations are supplied, so the description carries the full behavioral burden. 'Get' implies a read, but nothing states required permissions, whether the response includes reviewers/changes/checks, or how it behaves when the project-scoped ID does not exist. Only the ID-scoping behavior is disclosed.

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?

A single front-loaded sentence with the key fact (no repositoryId needed) stated first and no filler. The parenthetical packaging of the scoping note is slightly terse but costs nothing in clarity.

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 read tool with full schema coverage and no output schema, the essentials are present. Still, with zero annotations, the agent gets no signal about permissions, error behavior, or what facets of the pull request come back, which leaves the mutation/read profile and return shape underspecified.

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 100%, so projectId, pullRequestId, and organizationId are already documented in the schema. The description adds only the notable point that pullRequestId is resolved within the project scope rather than a repository, which is marginal value beyond the schema baseline.

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 specific verb and resource ('Get a pull request by ID') and adds a scoping qualifier that separates it from a repositoryId-based variant. It is clear what the tool does, though the contrasting tool it alludes to is never named, so differentiation relies on inference.

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 phrase 'best for Azure DevOps Server where PR IDs are project-scoped' gives a genuine usage context that implies an alternative for cloud/organization-scoped lookups. However, that alternative is never named and no explicit when-not-to-use condition or prerequisite is given.

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