List Scaleway Audit Trail custom alert rules

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and openWorldHint. The description adds critical behavioral insight: a caveat that the API returns 501 in practice, explains permission sensitivity beyond the annotation hints, and advises on error handling. No contradiction with annotations.

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?

Two paragraphs: first concisely states purpose and sibling distinction; second covers caveat and resolution. Every sentence adds unique value with zero waste. Front-loaded with actionable info.

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 no output schema, the description explains what fields the return will include (query, evaluation window, threshold, severity, status). Covers permissions, error handling, and real-world viability. Highly complete for a list tool with strong annotations.

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% with good descriptions. The description adds minimal extra parameter detail but the schema already covers defaults, filters, and pagination cap well. A slight bonus as the description contextualizes the region and status within the organizational scope.

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?

Description clearly states the tool lists an Organization's custom Audit Trail alert rules with specific fields (query, evaluation window, occurrence threshold, severity, status). It distinguishes from scaleway_audit_list_alert_rules (preconfigured rules). Verb + resource + scope is precise.

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 tells when to use this tool (listing custom rules) vs. the sibling scaleway_audit_list_alert_rules (preconfigured). Provides a real-world caveat that the API endpoint is non-functional (HTTP 501) and advises not to retry, directing to the working alternative. Also explains permission requirements and a fix if authorization fails.

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