set_audit_retention

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

Discloses important behavioral traits: that it does not toggle audit state, and the caution about eventual consistency potentially reverting recent action-group changes. With no annotations provided, the description fully carries the burden of transparency.

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?

Well-structured with clear sections: purpose, prerequisite, caution, and parameter list. Slightly lengthy due to caution detail but remains efficient and readable.

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?

Covers prerequisites, side effects, and parameter details. Output schema exists but is not shown; description does not mention return value, but given output schema, this is acceptable. Overall complete for intended use.

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?

Adds meaning for all three parameters (workspace, warehouse, days) beyond the schema, specifying data types and constraints. Schema description coverage is 0%, so the description compensates well, though could include examples or format hints.

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 the specific action: 'Update the audit log retention period without changing the audit enabled/disabled state.' This distinguishes it from sibling tools like enable_audit or disable_audit.

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 states prerequisite ('Audit must already be enabled; if disabled, enable it first with enable_audit') and provides a caution about eventual consistency, giving clear guidance on when and how to use the tool.

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