pmg_quarantine_spamusers

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

With no annotations provided, the description carries the full burden. It states the tool is read-only ('read'), notes a required configuration ('Needs PROXIMO_PMG_* config'), and provides the API path and parameter mappings. It does not disclose potential side effects (minimal) or rate limits, but the read-only context and config requirement are well communicated.

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 main purpose, and uses a structured format with bullet points for parameter details. Every sentence adds value 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?

Given the moderate complexity (4 parameters, output schema exists), the description covers purpose, parameters, config requirement, and API path. However, it does not describe the output format or pagination, though the existence of an output schema reduces the need. It is mostly complete for a read-only list 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 low (25%), but the description adds significant meaning: it specifies quarantine_type options ('spam|virus|attachment') with default 'spam' and API mapping, and clarifies that start/end are Unix epoch timestamps mapped to starttime/endtime. This compensates for the schema's lack of detail.

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 'List users with quarantined mail entries (read)', providing a specific verb (list), resource (users with quarantined mail entries), and scope. It distinguishes from sibling tools like pmg_quarantine_spam by focusing on users rather than individual mails.

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 implies usage for listing users with quarantined entries and mentions required configuration, but it does not provide explicit guidance on when to use this tool compared to alternatives (e.g., pmg_quarantine_spam for individual mails). No exclusions or alternative tool references are given.

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