inventory-diff

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

The description lists return values (added/removed hosts/groups, changes), adding some transparency. However, it does not disclose potential side effects, permissions, or limitations. No annotations are provided, so the description bears full burden but falls short.

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 extremely concise and well-structured, front-loading the purpose followed by a clear bullet list of return values. Every sentence contributes value.

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 complexity of 7 parameters and an output schema, the description lacks essential context such as inventory format support, path resolution, and behavior when parameters are null. It does not compensate for the sparse schema.

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?

With 7 parameters and 0% schema description coverage, the description adds minimal parameter semantics. Only 'include_hostvars' is hinted via 'optionally hostvars keys'. No explanation of left/right project roots, inventory paths, or ansible_cfg_path.

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 diffs two inventories, specifying the resources: hosts, groups, and optionally hostvars keys. This distinguishes it from sibling tools like inventory-find-host or inventory-graph.

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 use for comparing inventories but provides no guidance on when not to use, prerequisites, or alternatives. Without such context, an agent may misuse the tool.

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