check

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

Beyond the read-only/idempotent/open-world annotations, the description discloses verdict categories, per-item contents, offline CSAF vs live OpenVuln behavior, CISA KEV feed downloading, and only_findings filtering. These are concrete behavioral traits that materially help an agent invoke the tool correctly.

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 compact and front-loads the main action and verdict model before listing parameter notes. The fragment style is efficient, though the inventory/netbox omission means it is concise at the cost of completeness.

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 tool has 7 parameters, output schema support, and open-world annotations. The description covers the main workflow and outputs, but missing inventory/netbox_filter semantics and prerequisites for live OpenVuln/CISA downloads leave meaningful gaps.

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 carry parameter meaning. It explains devices, rules, versions, kev, and only_findings, but omits inventory and netbox_filter entirely, leaving two parameters undocumented.

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 a specific verb and resource: matching advisory rules against device configs, with one verdict per device/rule. It does not explicitly differentiate itself from siblings such as report, though it does point to list_devices/list_rules for inputs.

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?

Usage is implied by the purpose and by references to list_devices/list_rules for valid names, plus defaults for devices/rules. However, it does not say when to use check versus report, nor does it state when not to use it.

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