Get system component inventory

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

The description discloses meaningful behavioral details: each member is fetched when include_details is true, vendor-reported fields vary, and the response includes a details_truncated flag. This goes beyond the annotations (readOnlyHint, idempotentHint, etc.) and adds valuable context about what the tool actually does.

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 concise, front-loaded with the primary action, and includes a return structure explanation plus an example. Every sentence contributes information without redundancy.

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 tool of this complexity, the description covers the walk behavior, output structure, optional details, and a usage example. The presence of an output schema further enhances completeness, but the description alone is sufficient for understanding the tool.

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 coverage is 100% and each parameter is described, but the tool description adds extra meaning by explaining the effect of include_details on the output and providing a concrete usage example. This enhances the parameter semantics beyond the schema alone.

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 states the tool walks the Processors, Memory, Storage, EthernetInterfaces, and PCIeDevices collections of one system, making the purpose explicit and specific. It distinguishes itself from sibling tools like get_system or redfish_walk by describing a distinct aggregated inventory operation.

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 provides clear context on when to use the tool (to retrieve component inventory for a system) and explains the behavior of include_details. It does not explicitly name alternatives or exclusions, but the context is sufficient for an agent to select this tool appropriately.

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