ado_get_pull_request_commits

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

No annotations are provided, so the description bears the full burden. It does not disclose behavioral traits such as pagination (the 'top' parameter), authentication needs, rate limits, or that results may be truncated. The description only states the basic function without additional 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 sentence with no unnecessary words. It is front-loaded and efficient. Every word serves a purpose, and there is no redundancy.

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?

Given no output schema and only three parameters, the description should provide more context, such as return value format, pagination behavior, or required permissions. It is minimal and does not cover enough for an agent to fully understand the tool's capabilities and constraints.

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?

The input schema has 100% description coverage, so the baseline is 3. However, the description does not add value beyond the schema; it merely repeats the function. Moreover, it misleadingly states 'all commits' when the 'top' parameter implies a limit, which could cause misinterpretation.

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 the action ('gets all commits') and the resource ('Pull Request'). However, it claims 'all' commits while the schema includes a 'top' parameter for limiting results, which is a slight inaccuracy. It does not differentiate from sibling tools like 'ado_get_pull_request' or 'ado_get_pull_request_reviewers', but the purpose is specific enough.

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 is provided on when to use this tool versus alternatives. There is no context about prerequisites, filtering, or when to prefer other tools like 'ado_get_pull_request' for broader information.

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