pdm_users_list

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

With no annotations provided, the description discloses key traits: read-only, no state change, credential-shaped keys are stripped, and include_tokens behavior. It also mentions config requirement. Lacks details on edge cases or rate limits, but sufficient for a list tool.

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?

Very concise: 4 sentences, front-loaded with 'READ-ONLY' and core purpose. No fluff, every sentence adds value.

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 that output schema exists (so return details are covered), the description adequately covers purpose, behavioral traits, and alternative tool. Mentions config requirement. Could be more explicit about what the list contains beyond tokens, but 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 coverage is 100%, so baseline is 3. The description reiterates that include_tokens includes API tokens, which matches the schema description, but adds no new meaning beyond what's in the schema.

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 clearly states it lists PDM's own user accounts (not a remote managed cluster's users), specifies it is read-only, and distinguishes from pve_users_list. It also notes the include_tokens option for including API tokens.

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?

Explicitly mentions 'No state change' and directs to pve_users_list for managed PVE cluster users. It also mentions the necessary config (PROXIMO_PDM_*). However, it does not elaborate on broader usage contexts or exclusions.

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