hs4.admin.users.list

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

No annotations provided, and the description omits all behavioral traits. It does not state that the tool is read-only, does not describe pagination, rate limiting, or permissions. The burden is entirely on the description, and it fails.

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 a single sentence, which is concise. However, it is too minimal—it earns its place for stating purpose but provides no additional valuable information. A longer description would be justified.

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 two parameters, no output schema, and many sibling tools, the description is severely incomplete. It does not explain return values, pagination behavior, filtering options (if any), or how to handle errors. Completely inadequate.

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%, and the description says nothing about the parameters (limit, includeDisabled). The description adds no meaning beyond the parameter names, which are self-explanatory but lack context (e.g., what does includeDisabled affect?).

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 explicitly states the action (List), the resource (HS4 users), and the scope (admin namespace), clearly distinguishing it from sibling create/update/delete tools.

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?

No guidance on when to use this tool versus alternatives like hs4.devices.list or hs4.events.list. No mention of prerequisites or context.

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