ansible-compare-states

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

With no annotations, the description carries the full burden. It only says 'compare,' which suggests a read operation but does not explicitly confirm side effects, error conditions (e.g., missing baseline), or any other behavioral traits.

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 and front-loaded with the purpose sentence. However, the parameter list is redundant with the schema and could be omitted or integrated into the purpose sentence.

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 6 parameters, no annotations, and the presence of an output schema, the description is incomplete. It does not explain return values, behavioral context, or how to interpret results.

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 lists parameter names in an Args block but provides no additional meaning beyond what the input schema shows. With 0% schema coverage, this is insufficient to help an agent understand parameter format or constraints.

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's purpose: 'Compare current system state against a previously captured baseline.' It uses a specific verb and resource, and distinguishes itself from sibling tools like `ansible-capture-baseline`.

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 implies usage (after having a baseline snapshot) but provides no explicit when/when-not guidance or alternatives. Siblings like `ansible-diagnose-host` or `ansible-health-monitor` are not mentioned.

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