hmc_users

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

With readOnlyHint=true already indicating a safe read operation, the description adds valuable behavior details: returns None if a user is not found, ignores 'user_type' when 'name' is supplied, and describes the return structure including the flattened HmcUser fields. These go beyond the annotation and enhance transparency.

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 and well-structured: a one-sentence summary, followed by clear conditional behavior and return format. Every sentence adds necessary information without fluff.

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?

Despite having no output schema, the description explains the return format in enough detail. It covers both usage modes, parameter semantics, and the read-only nature of the operation, making it complete 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?

Schema description coverage is 0%, so the description fully compensates by explaining both parameters: 'name' (optional, fetches a single user) and 'user_type' (filters the list, with enum values 'local', 'kerberos', 'all', and default 'all'). It also clarifies the interaction between parameters.

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 a specific verb+resource: 'List HMC user accounts or get one by username.' It clearly distinguishes the two modes (list all vs. get by name) and focuses on user accounts, setting it apart from sibling tools that manage other HMC 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 gives clear context on when to use each mode: when 'name' is provided, it fetches a single user; when omitted, it lists all users with optional filtering by 'user_type.' It does not explicitly mention alternatives (e.g., other user-management tools), but the scope is well-defined.

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