generate_report

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

Discloses key behavioral traits beyond annotations: immediate return with PENDING status, polling requirement, scoping to resource_ids if provided. Annotations already indicate non-readonly, non-destructive, non-idempotent, open world, and description adds valuable async details.

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?

Efficiently structured: purpose sentence, async workflow description, then parameter details. No wasted words, essential information 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?

Complete for an async generation tool: explains return format (report_id, status), how to get results (poll get_report), and how to use download_url. Provides source for definition_id. No output schema needed.

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?

Despite 0% schema coverage, the description fully explains each parameter: definition_id sourced from list_report_definitions, resource_ids as optional scope with default behavior, target as optional name from config with fallback. Adds meaning well beyond schema types.

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 tool triggers report generation from a template, using specific verb 'Trigger generation' and resource 'report'. It distinguishes from siblings like get_report and delete_report by focusing on the creation step.

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 clear usage context: use to initiate report generation, explains asynchronous nature, and gives polling instructions with get_report. Does not explicitly list when not to use, but the context is sufficient.

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