github_compare_commits

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

No annotations are present, and the description fails to disclose any behavioral traits. It does not mention authentication, rate limits, side effects, or what the operation actually does (e.g., returns a diff).

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 short but wastes space on routing details (e.g., 'Routes through /api/tools/invoke under your JWT...') that are irrelevant for tool selection. It lacks essential operational information.

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?

Despite having an output schema (not shown), the description provides no information about return values or behavior. For a tool comparing commits, critical context like comparison scope, format of results, and limitations is absent.

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 schema has one parameter 'arguments' (string) with 0% description coverage. The description merely states it's a 'JSON string of arguments for the connector operation,' adding no meaningful semantics beyond the schema type.

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 mentions it's a 'compare_commits' operation but never explains what comparing commits entails (e.g., comparing two branches or commits). It focuses on routing details, leaving the core purpose unclear.

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 like github_list_commits or github_get_branch. The description does not distinguish use cases.

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