cve_lookup

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

With no annotations, the description must disclose behavioral traits. It mentions using the NVD API, implying an external call, but does not disclose rate limits, caching behavior, response format, error handling, or whether it is a read-only operation. The description carries the full burden and falls short.

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 a single, concise sentence of 13 words that conveys the core purpose without any redundant information. Every word is functional.

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 tool's simplicity (2 required parameters, no nested objects) and the presence of an output schema (so return values need not be explained), the description is somewhat complete. However, it lacks usage guidelines and behavioral transparency, which are important for a remote API call tool. It is adequate but has clear 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 compensate. It adds minimal meaning by stating that 'software' refers to a software name and 'version' to its version, but does not explain format constraints, valid values, or how they are used in the API call. The addition is helpful but not comprehensive.

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 action ('Look up'), the target resource (known CVEs), the required inputs (software name and version), and the data source (NVD API). It is specific and distinguishes the tool from siblings like whois_lookup or port_scan.

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 provides no guidance on when to use this tool versus alternatives, no prerequisites, and no context about limitations or expectations. For example, it does not explain that this is a vulnerability lookup that should be used during security assessment, nor does it mention 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.