create_vulnerability_report

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

No annotations are provided, so the description carries full burden. It does disclose that the AI should be concise and brief, and provides a template structure for generated fields, but it does not state whether the tool persists data, returns a report ID, or requires authentication. This leaves the agent without key behavioral expectations.

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 moderately sized and uses a numbered list for clarity. However, it duplicates much of the information already in the parameter schema, and the 'IMPORTANT FOR AI' repetition could be trimmed. It is structured but not maximally efficient.

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 the tool's complexity (7 params, nested objects, no output schema), the description omits important contextual details such as return value, error conditions, or how it relates to the report lifecycle. It covers the content format for AI-generated fields but leaves the overall workflow unclear.

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 71%, and many parameter descriptions already contain length/format constraints. The main description largely reiterates these constraints (e.g., '2-3 sentences', '3-4 brief bullet points') without adding new syntax or type information. Thus it provides minimal added value beyond the 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 begins with a clear verb-action: 'Create a professional vulnerability report following the standardized template format.' This clearly identifies the tool's purpose and distinguishes it from sibling tools like list_reports or export_report.

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 guidance on when to use this tool versus alternatives. It does not mention prerequisites (e.g., needing browser_test_payload results), nor does it differentiate from sibling tools like add_evidence_to_report or get_report_template.

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