devops_repository_diffs_commits

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

The description only says 'Get the difference,' which is consistent with the readOnlyHint annotation, but it adds no additional behavioral details such as what the diff includes, error handling, or limits. The agent gains little beyond the annotation indicating safe read operation.

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 sentence with no filler—very concise and front-loaded. Every word is necessary to convey the core purpose.

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 the low complexity (3 required params, read-only, output schema exists), the description is adequate but minimal. It does not explain what the diff contains or what format the result is in, though the output schema presumably fills that gap. It leaves the agent without guidance on the scope of 'difference.'

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?

All three parameters are described in the schema with examples and full coverage (100%). The description adds no extra meaning about the parameters, so the baseline score of 3 applies as the schema already does the heavy lifting.

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 tool gets a diff between two commits, using a specific verb and resource. However, it does not explicitly differentiate from sibling tools like devops_get_item_content_diff or devops_repository_commit_changes, leaving some ambiguity about when to use this vs others.

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. The description simply states the action without any context about use cases, prerequisites, or when not to use it.

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