generate_maturity_report

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

No annotations are provided, but the description explicitly states 'Read-only', which is a key behavioral trait. It also mentions the dependency on service_detection output. However, it lacks details on state changes, return format, or safety beyond the read-only claim.

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 extremely concise at two sentences, covering purpose, precondition, and safety in a front-loaded manner. Every sentence serves a clear purpose with no redundancy.

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 there is no output schema, the description fails to explain what the report contains or its return format (e.g., file path, string). This leaves the agent without necessary information to handle the tool's output, making it incomplete for a report generation 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?

Schema coverage is 100%, so the baseline is 3. The description does not add meaning beyond what the input schema already provides for the two parameters (scan_results and lang).

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 it generates a security maturity assessment report from scan_all results, with a specific verb and resource. It mentions dependency on service_detection module output, which adds context but does not explicitly differentiate from sibling report generators like generate_report or generate_html_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 indicates that the tool requires service_detection module output, providing a precondition for use. However, it does not give guidance on when to use this tool over siblings or when not to use it, leaving the agent to infer usage context.

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