generate_mlps3_report

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

Declares 'Read-only', indicating no side effects. No annotations provided, so description carries full burden. Does not detail other behavioral traits but the read-only flag is strong.

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?

Two sentences with no redundancy. Purpose and usage immediately stated. Every sentence earns its place.

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?

No output schema, but description adequately covers input and behavior. Could mention output format (e.g., HTML, PDF) but not critical for a report generator.

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 baseline is 3. Description adds value by clarifying that scan_results should come from mlps3_precheck, enriching parameter meaning.

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 GB/T 22239-2019 等保三级 compliance pre-check report from scan results. It specifies the standard and compliance level, and distinguishes from siblings like generate_html_report or generate_maturity_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?

Explicitly recommends usage with 'scan_group mlps3_precheck results', providing clear context when to use. Could further exclude alternatives but is sufficiently clear.

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