Api vulnerabilities list

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds nothing usable about behavior: it doesn't mention pagination (relevant given limit/offset/max_pages), default ordering, the filtering behavior, or the shape of results.

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?

It is short, but the single sentence is spent on internal framework mechanics rather than front-loading the resource and operation. Brevity here reflects under-specification, not efficiency.

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?

A 17-parameter, zero-coverage, no-output-schema list endpoint needs far more context than this. The description leaves an agent unable to determine what the tool returns, how to filter meaningfully, or whether it paginates.

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% across 17 parameters, so the description must compensate, and it does not. Filters like severity, status, cwes, assets, findings, security_advisories, filtering_labels and pagination controls are completely undocumented anywhere.

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 is a Django implementation note ('Override the list method to inject optimized data into the serializer context') rather than a statement of what the tool does. Only the tool name hints that it lists vulnerabilities; the text itself never says it retrieves or lists vulnerability records, nor how it differs from siblings like ciso_assistant_api_vulnerabilities_retrieve or _autocomplete_retrieve.

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?

There is no guidance on when to call this versus the many sibling list/retrieve/object_retrieve tools. Nothing indicates prerequisites, scope, or exclusions, and the implementation-focused phrasing actively misdirects an agent away from thinking of it as a query entry point.

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