Compare two ISM versions

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

With no annotations, the description carries the full burden. It honestly discloses that the tool computes added, removed, and modified controls, and mentions the includeBodies parameter makes output verbose. However, it does not address potential side effects, rate limits, or the read-only nature, though the operation is clearly non-destructive.

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 composed of two tightly focused sentences. The first sentence defines the core functionality and output details, and the second sentence provides a use case. No extraneous information, making it highly efficient.

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 lack of an output schema, the description does not explain the return format or structure, which an agent might need to process results. It also does not mention any prerequisites or error conditions. While the core function is clear, additional context would improve completeness.

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 input schema has 100% coverage with clear descriptions for all three parameters (from, to, includeBodies). The tool description does not add additional meaning beyond the schema, so a baseline score of 3 is appropriate.

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 action ('Computes the diff') and the resource ('between two ISM releases'), specifying the exact types of changes included (added, removed, modified with details). This distinguishes it from sibling tools like list_versions or get_control, 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?

The description mentions it is 'useful for change-management and gap analysis,' providing context for use. However, it does not explicitly state when not to use this tool or suggest alternatives (e.g., using get_control for a single version or list_versions for version listing).

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