compare_commits

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

Annotations are absent, so the description must carry the full burden of behavioral disclosure. It only states 'Compare two refs' without indicating whether the operation is read-only, what kind of output to expect, or how the 'straight' parameter affects behavior. This leaves significant ambiguity.

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, front-loaded sentence with no unnecessary words. It quickly conveys the core purpose and parameters, and is appropriately concise for the tool's simplicity.

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 tool with no annotations and minimal schema descriptions, the description is incomplete. It lacks usage context, alternative guidance, and explanation of the 'straight' parameter. The existence of an output schema mitigates some need for return-value details, but the description still fails to provide a full picture for an AI agent.

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 description partially explains that from_ref and to_ref are refs (branch/tag/sha) and implies project context, but it completely omits any explanation of the 'straight' parameter. With zero schema description coverage, this leaves one of four parameters undocumented, providing insufficient semantics.

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 identifies the action (compare) and resource (two refs in a project), and specifies the ref types (branch/tag/sha). This distinguishes it from sibling tools like list_commits and get_commit, which serve different purposes.

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 such as list_commits or get_commit. The description does not mention specific use cases, exclusions, or comparisons with other commit-related tools.

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