get_audit

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

Discloses polling behavior, access restriction, and that download URLs are short-lived. Without annotations, the description covers key behavioral aspects, though it omits potential error states or rate limits.

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?

Single paragraph is concise but packs multiple pieces of information. Could be more structured 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?

Given no output schema, the description explains the output structure well (status, progress, severity, download URLs). Includes polling interval and access rules, making it sufficiently complete for a monitoring 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?

Input schema covers the single parameter 'id' with its description. The tool description adds no extra parameter meaning beyond what the schema already provides.

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?

Clearly states the tool checks an audit started with start_audit and lists returned data (status, progress, severity, URLs). Distinguishes itself from sibling tools by specifying its role as a polling endpoint for audit results.

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?

Provides polling guidance (every ~15s) and access restriction (only the starter account). Implicitly tells when to use (after start_audit) but does not explicitly list alternatives or when not to use.

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