compare_deployments

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

No annotations are provided, so the description carries the full burden. It usefully describes the return content (commits, authors, files changed) and hints at a GitHub-backed operation via 'via GitHub', but discloses nothing about authentication requirements, rate limits, or fallback behavior when repo/owner are unset.

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 zero waste that covers the operation, inputs, and outputs in one pass.

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?

With no output schema, the description steps in to describe what is returned (commits, authors, files changed), which is the key missing piece. The remaining gap is behavioral context (auth, GitHub token expectations) on an unannotated read tool, which keeps it from a full 5.

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 100%, so all four parameters (repo, owner, base_sha, head_sha) are already documented in the schema. The description echoes the base/head concept without adding format or ordering semantics beyond what the schema already provides; baseline 3 applies.

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 (compare) and resource (two deployments or commit SHAs) and names the output (commits, authors, exact files changed). The comparison semantics make it clearly distinct from siblings like get_deployments and get_commit_details, which retrieve single items rather than diffing two.

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?

Usage is implied by the purpose: you call this when you want to diff two deployments or SHAs. However, it names no alternatives and gives no when-to-use/when-not conditions, so the agent must infer the trigger context.

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