hmc_list_io_slots

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

The description goes well beyond the readOnlyHint annotation by detailing the exact HMC command executed, the UUID resolution process with fallback, and the output structure. It also specifies the pci_class filter values and their PCI class codes, providing transparent behavior.

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 structured with a clear opening sentence, followed by command details, output description, and filter documentation. Each section adds necessary information without redundancy, making it concise despite its length.

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 tool's moderate complexity (2 params, output schema exists), the description covers the purpose, command, output fields, parameter semantics, and resolution behavior. It is complete enough for an agent to select and invoke the tool correctly.

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 input schema only lists parameter names without descriptions. The description compensates by explaining that system_name_or_uuid can be a CLI name or UUID and how it is resolved, and by fully documenting pci_class values including defaults and the meaning of each filter.

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 opens with 'List physical I/O slots on a managed system via the HMC CLI,' clearly identifying the action (list) and resource (physical I/O slots). It also specifies the underlying command and output format, distinguishing it from sibling tools like hmc_list_adapters or hmc_list_resources.

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 usage context by explaining the system parameter (CLI name or UUID) and the pci_class filter options with their meanings. However, it does not explicitly mention alternative tools or when not to use this tool, so it lacks exclusions beyond the clear context.

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