aap_export_inventory

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds context about the output being YAML for infra.aap_configuration.controller_inventories and clarifies the format parameter allows 'yaml' or 'json', exceeding mere annotation coverage.

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 compact, front-loaded with the core purpose, and uses a structured Args/Returns format. Every sentence adds value without redundancy, and the entire description is appropriately sized for the tool's simplicity.

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?

For a simple read-only export tool with annotations and an output schema, the description covers purpose, parameters, and return format sufficiently. It does not need additional side-effect or error-handling details, making it complete for the tool's complexity.

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's Args section provides meaningful explanations for all three parameters (inventory_id, include_hosts, format), including allowed values for format. This compensates for the schema's low description coverage and adds clarity beyond the basic types and defaults.

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 exports an AAP inventory as Configuration-as-Code YAML, specifying the action, resource, and output format. It is distinct from sibling export tools (e.g., aap_export_project) by explicitly naming the inventory as the target resource.

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 for exporting inventories but does not explicitly discuss when to use this tool versus alternatives like aap_export_all_resources or other export tools. There is no exclusion guidance, so it is clear but not fully explicit.

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