list_systems_needing_update_for_cve

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

Discloses behavioral traits such as limit capped at 500 and that returned items are unique. However, lacks information on side effects, permissions, or rate limits. No annotations provided to complement or contradict.

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?

Three short sentences, no wasted words. Front-loaded with main purpose, followed by parameter summary and return format.

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 presence of an output schema (indicated by context signals), the description sufficiently explains inputs and return structure. For a filtered list tool with pagination, it covers essential aspects.

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 has 0% description coverage, so description adds value by explaining the purpose of each parameter (cve_identifier required, limit and offset optional with defaults and cap). Adds context beyond raw schema.

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?

Description clearly states the tool lists systems affected by a CVE, with specific inputs and outputs. It is distinguishable from siblings like list_systems (list all systems) and list_systems_needing_reboot.

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?

No guidance on when to use this tool versus alternatives. For example, it doesn't mention when to use list_systems_needing_update_for_cve vs check_all_systems_for_updates or other sibling tools.

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