generate_pdf_report

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. The description only states that it generates a PDF, but does not mention whether it overwrites files, requires specific permissions, or if the output_path must be writable. It also doesn't describe the return value or confirmation behavior, leaving the agent with minimal insight into side effects or dependencies.

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 a single concise sentence with no padding, which is efficient for a tool with a straightforward purpose. However, given the complexity of the parameters (especially the unstructured scan_results object), a bit more elaboration would be justified without losing conciseness.

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, no parameter descriptions, and no annotations, the description is incomplete. The tool accepts an opaque scan_results object (which likely influences report content) and outputs a PDF, but there is no guidance on what makes a valid input or what the output format includes. For a tool intended to work alongside many scanning siblings, more context on expected input structure is 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?

Schema description coverage is 0%, meaning the JSON schema has no description fields for the parameters. The tool description does not compensate—the 'scan_results' parameter is an object with additionalProperties (i.e., arbitrary structure), but no guidance is given on its expected structure or content. The 'output_path' parameter has a default but no explanation of file naming conventions or restrictions. The tool description adds no value beyond the parameter names.

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 generates a PDF vulnerability report, using a specific verb (generate) and resource (PDF report). It distinguishes from sibling tools like generate_html_report and export_findings_json by specifying PDF format rather than HTML or JSON. However, it doesn't elaborate on the scope or content of the report beyond 'vulnerability', leaving some ambiguity about how comprehensive the report is compared to HTML or JSON output.

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 provides no explicit guidance on when to use this tool versus alternatives. Sibling tools like generate_html_report and export_findings_json likely serve similar purposes but with different output formats, yet no comparison or conditional advice is given. The context where a user would prefer PDF over HTML or JSON is left entirely to the agent to infer.

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