get_workload_cves

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

With no annotations, the description carries the full burden. It does disclose that this is a read operation via the underlying 'GET /openapi/v1/workload/{uuid}/vulnerabilities' endpoint and that results include a severity tally (critical/high/medium/low), which adds real behavioral context. It says nothing about pagination, result limits, or permissions, so gaps remain.

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?

Front-loaded with the core purpose in one sentence, followed by tightly scoped Args and Returns notes. Every line earns its place; the only minor overhead is the docstring-style formatting.

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 a single required parameter and an existing output schema, the definition supplies what an agent needs: purpose, parameter provenance, and return-shape hint. Minor omissions around pagination and access requirements keep it short of complete.

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%, so the description must compensate for the single parameter, and it does: it identifies `uuid` as the workload/sensor UUID and points to `list_sensors` as the source. This adds provenance beyond the bare 'string' type, though it doesn't specify format or validation.

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?

States a specific verb and resource ('List CVEs / vulnerabilities') with explicit scope ('on a single workload'). An agent can distinguish it from inventory-oriented siblings like get_workload_packages or the aggregate top_vulnerable_hosts, though no sibling is named directly.

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 Args note gives useful provenance for the required parameter ('from `list_sensors`'), which tells the agent where to obtain input. However, there is no explicit when-to-use guidance relative to alternatives such as top_vulnerable_hosts, and no stated prerequisites or exclusions.

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