zeasm_get_finding_scan_output

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

Annotations already declare readOnlyHint=true, and the description adds useful behavioral context: it states returns full scan 'content' and 'source_type', notes that content can be large free-form text and is preserved verbatim. This adds value beyond the annotations.

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 two sentences: the first clearly states the purpose, and the second adds key details about the return value and content nature. No extraneous information, appropriate length.

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 simplicity (2 parameters, no output schema), the description covers the return fields (content and source_type) and highlights the content's potential size and verbatim preservation. However, it lacks parameter details, which would make it more complete. Overall, adequate for the tool's complexity.

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 0%, yet the description does not explain the two required parameters (org_id, finding_id). It mentions 'one EASM finding' which hints at finding_id but does not define it, and org_id is not addressed at all. The description fails to compensate for the lack of schema descriptions.

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 states 'Get the complete scan output for one EASM finding' which clearly identifies the verb (Get) and the resource (complete scan output for a finding). This distinguishes it from sibling tools like zeasm_get_finding_details and zeasm_get_finding_evidence.

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 does not provide guidance on when to use this tool versus alternatives such as zeasm_get_finding_details or zeasm_get_finding_evidence. It only mentions 'Read-only' but no explicit when-to-use or when-not-to-use instructions.

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