generate_report

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

No annotations exist, so the description must carry all behavioral disclosure. It only says 'Generate a structured report' without describing return values, side effects, or required permissions. The description adds little beyond what the tool name implies.

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 concise and front-loaded with the main purpose. It efficiently integrates parameter explanations without unnecessary filler. The multi-line format, while not formal, is still readable and scannable.

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 and no annotations, the description is incomplete. It does not explain what the report looks like, how it is returned, or how it differs from the sibling generate_pentest_report. The lack of context around the report structure and tool selection leaves significant gaps.

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 description coverage is 0%, but the description compensates by explaining each parameter in plain language: job_ids are from list_jobs or get_job_status, title is the report title, and format is 'markdown' or 'json'. This adds meaningful meaning beyond the bare 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 clearly states 'Generate a structured report from completed job results', which uses a specific verb and resource. However, there is a sibling tool 'generate_pentest_report' that likely overlaps in purpose, and the description does not differentiate between them.

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?

The description implies usage by saying job_ids come from list_jobs or get_job_status, which gives some context. But it does not explicitly state when to use this tool versus alternatives like generate_pentest_report, nor does it provide exclusions.

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