shodan_cve

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

Discloses authentication requirements ('zero-auth') and what data is returned, but does not detail error handling or rate limits; adequate for a lookup tool without annotations.

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?

Two sentences, front-loaded with purpose and returns, no unnecessary words.

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?

Specifies return fields (CVSS, EPSS, KEV, CPEs, references) and positions as comprehensive, but omits error behavior or handling of missing CVEs; sufficient for a simple lookup 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?

Schema coverage is 100% with a clear description; the description does not add additional meaning beyond the schema, meeting baseline.

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?

Clearly states 'Look up a CVE via Shodan CVEDB', specifying verb, resource, and distinguishing source from siblings.

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?

Indicates zero-auth and no API key, implying easy access; lists returned data, suggesting scenario of comprehensive lookup, but lacks explicit alternatives or when-not.

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