shodan-parse-query

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It discloses the API key requirement and mentions the return type (QueryTokensResult), but does not discuss rate limits, error behavior, or the fact that the operation is non-mutating. This is moderate disclosure but incomplete.

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-loaded with the primary purpose. The 'Returns' line is clearly separated for readability. Every sentence adds value, with no redundant or wasted text.

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?

With an output schema present and only two simple parameters, the description adequately covers the tool's function and return type. It provides enough context for an agent to select and invoke it correctly, though it could be more explicit about how it differs from sibling search tools.

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 provides 100% coverage for both parameters: query has a description and example, timeout has a description and default. The description adds no additional parameter semantics beyond what the schema already documents, so the baseline score of 3 applies.

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's function with a specific verb and resource: 'Parse and analyze a Shodan search query into its components.' It further enumerates component types (attributes, filters, errors, search string), making the purpose explicit and distinct from siblings like shodan-search or shodan-search-count.

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 states it is 'useful for debugging complex queries and understanding how Shodan interprets them,' providing clear context on when to use it. It does not explicitly mention alternatives or exclude other tools, but the context implies it is not for executing searches, and the API key requirement is noted.

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