compare_scans

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

Describes return type ('Changes in assets, relationships, and attack paths') but does not disclose potential side effects, performance implications, or definition of 'previous scan'. No annotations provided to compensate.

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?

Extremely concise—three lines with no redundant information. Every sentence contributes meaning: purpose and return type.

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 zero parameters and existence of an output schema, the description is largely complete. However, it could clarify what constitutes 'previous scan' (e.g., immediately prior or any selected) and mention that comparison is read-only.

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?

No parameters exist, so baseline is 4. The description adds value by specifying the return content, but does not need to elaborate on parameters.

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?

Clear verb 'Compare' with specific resources 'latest scan to previous scan'. Distinguishes from sibling tools like get_assets or get_attack_paths which retrieve individual entities rather than comparing two scans.

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?

Implies usage for viewing changes between scans but lacks explicit guidance on when to use this vs alternatives like get_scan_summary or get_findings. No exclusions or prerequisites stated.

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