generate_sast_report

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

The description only labels the tool as 'Legacy', which implies it may be outdated or unsupported, but does not disclose any behavioral details such as potential side effects or deprecation consequences. Without annotations, the description carries the burden of transparency and fails to provide substantive behavioral context.

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 sentence that is concise and front-loads the critical deprecation notice. While very brief, it purposefully avoids extraneous detail for a deprecated tool, earning 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?

Given that the tool is deprecated and the sibling tools include the recommended replacement, the description is functionally complete for its purpose. It directs agents to the correct tool without needing further elaboration.

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?

The input schema has three parameters with 0% description coverage, and the tool description adds no meaning or context for any parameter. Agents receive no guidance on what 'scan_path', 'report_dir', or 'format' represent or how to use them.

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 does not specify the tool's function beyond indicating it is legacy. The name 'generate_sast_report' hints at generating a SAST report, but the description provides no clarification of its purpose, making it nearly tautological.

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 explicitly states to use 'generate_enhanced_report' instead, providing clear and direct guidance on when to avoid this tool and which alternative to choose. This is optimal for a deprecated tool.

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