get_site_inventory

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

No annotations are provided, so the description carries full burden. It indicates the tool retrieves inventory (read operation) and lists components, but does not disclose potential permissions, data size implications, or whether it is cheap or expensive to call. The 'comprehensive' nature suggests a potentially heavy operation, which is not warned about.

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 well-structured with a clear purpose sentence, a bullet list of included resources (though not in markdown), and standard Args/Returns sections. It could be slightly more concise by removing the redundant 'Args' and 'Returns' labels if not needed, but overall it is 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?

With only one parameter and an output schema (not shown but indicated), the description provides adequate context: return type (site inventory or list of site inventories) and the scope of data. The tool is simple, and the coverage is sufficient.

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 description coverage is 0%, but the description adds meaningful context: it explains the site_id parameter is optional and that omitting it returns inventory for all sites. This goes beyond the schema's 'anyOf' type and default null.

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?

Description starts with a specific verb ('Get') and resource ('comprehensive inventory for a site or all sites'), and the bullet list of components clearly distinguishes it from sibling tools that retrieve individual elements (e.g., list_sites, get_site_details) or focus on performance (compare_site_performance).

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 explains the optional site_id parameter and its behavior ('If None, returns inventory for all sites'), but does not explicitly state when to prefer this tool over alternatives like get_site_details or list_sites. The usage context is implied but lacks explicit guidance or exclusions.

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