cve_search

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

With no annotations, the description discloses several behavioral traits: it queries the NVD database, caches results locally for 24 hours to respect API rate limits, and warns that the parameter must be named 'keyword' not 'query'. These go beyond a generic search description.

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 somewhat lengthy but well-structured with an important note up front and a clear Args/Returns format. Most sentences add necessary detail, though the keyword parameter is mentioned twice redundantly.

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 an output schema exists, the description adequately covers parameter semantics, defaults (implicit via schema), and behavior. It does not clarify whether parameters can be combined or if no parameters returns all CVEs, but it is fairly complete for a search tool.

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 0% description coverage, so the description must compensate. It explains every parameter with examples, constraints (e.g., max_results max 100, severity values), and meaning for cpe_name, days_back, etc., adding significant value beyond the 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?

The description clearly states the tool searches CVEs by keyword, product, CPE, or severity, with specific verbs and resource. However, it does not explicitly distinguish itself from the sibling 'cve_lookup' tool, so it lacks sibling differentiation.

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 gives context (queries NVD, results cached) but does not say when to use this tool versus alternatives like 'cve_lookup' or 'searchsploit_query'. There is no explicit when-to-use or alternative guidance.

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