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

No annotations provided, so description carries full burden. It correctly indicates the tool is read-only (produces a changelog) and warns about $ref limitations. Could mention potential performance or rate limits, but is otherwise clear about its non-destructive, analytical nature.

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?

Two efficient sentences: first states purpose and scope, second gives usage guidance and constraints. No wasted words, front-loaded with key 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?

Given the tool's complexity (two input params, no output schema) and sibling tools explained, the description is largely complete. It covers purpose, when to use, and constraints. Missing a description of output format (e.g., 'returns a Markdown changelog'), but overall adequate.

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% with descriptions for both params. Description adds the constraint that they must be valid, self-contained OpenAPI (YAML or JSON), which goes beyond the schema. A score of 4 reflects that it adds meaningful context beyond the schema's basic type/description.

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 produces a full changelog of every change between two OpenAPI specs, down to informational changes. It specifies the verb 'produce', the resource 'changelog', and distinguishes from siblings oasdiff_breaking_changes and oasdiff_diff.

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?

Explicitly says when to use this tool ('when you want the complete set of changes at every severity') and when to use alternatives ('oasdiff_breaking_changes instead when you only care whether the change is breaking', 'oasdiff_diff for the raw structural diff'). Also provides prerequisites: both specs must be valid, self-contained OpenAPI.

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