shodan_search

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

With no annotations, the description carries full burden. It only mentions the API key requirement, omitting details like rate limits, pagination behavior, and whether the operation is read-only. Users are left uninformed about potential side effects or limitations.

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 extremely concise: a single sentence with an example. Every word earns its place, and critical information (requires API key) is front-loaded.

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?

For a search tool with three parameters and no output schema, the description covers the basic function and authentication but lacks detail on return format, pagination, and facet usage. It is adequate for simple use but not comprehensive for complex scenarios.

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%, and the description adds value by providing a concrete query example for the 'query' parameter. However, it adds no additional context for 'page' or 'facets' beyond the schema descriptions.

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 Shodan for hosts matching a query, with an explicit example. This verb-resource combination distinguishes it from sibling tools like shodan_host (specific host details) and shodan_exploits (exploit search).

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 a query example but no explicit guidance on when to use this tool versus alternatives. It does not specify prerequisites or typical use cases beyond the required API key.

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