get_treemap

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

With no annotations, the description carries full burden. It discloses the return type (PNG image) and the availability condition. It does not discuss side effects, permissions, or error conditions, which is acceptable for a read-only retrieval tool.

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 concise, starting with the main purpose, then a note, followed by parameter and return information. Every sentence adds value without extraneous words.

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?

The description is complete enough for a simple tool with one parameter and an output schema. It covers the precondition and return type. Missing error handling details, but not critical for this use case.

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 no description for scan_id, so the description compensates by explaining that it is the scan ID to retrieve the treemap for. This adds necessary semantic meaning beyond the schema's title.

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 gets a treemap visualization image for a scan, specifying the resource and action. It does not explicitly distinguish from sibling tools, but it is unique in retrieving a treemap image, so differentiation is implicit.

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 notes that treemap images are only available if the scan was run with treemap=True, providing a precondition. However, it does not give explicit guidance on when to use this tool versus alternatives like scan_disk or list_scans.

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