pmg_quarantine_spamusers

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

The description declares READ-ONLY status, describes the return format (list of per-user dicts), and explains the quarantine_type parameter mapping to the API. With no annotations, it carries the full burden and does so well.

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 short, well-structured paragraph with no redundant information. Key points are front-loaded.

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?

For a read-only list tool with an output schema, the description covers essential aspects (config, parameters, return format). It is complete enough given the tool's simplicity.

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% and parameter descriptions are clear. The description adds some value (e.g., mapping quarantine_type to API parameter) but is not significantly beyond 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 uses a specific verb+resource ("list users with quarantined mail entries") and clearly distinguishes from sibling tools like pmg_quarantine_spam, which lists messages for one user.

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?

It states the config prerequisite (PROXIMO_PMG_* config) and explicitly recommends pmg_quarantine_spam for listing a single user's messages. However, it lacks explicit 'when not to use' guidance.

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