shodan_alert_get

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

The description adds no behavioral information beyond what the annotations already provide. It simply restates the purpose. It does not disclose return format, error behavior, authentication needs, or other limitations. Since the annotations already indicate a safe read operation, the description contributes little additional transparency.

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 that states the tool's purpose without any waste. It is front-loaded and easy to parse.

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?

This is a simple read tool with one required parameter and no output schema. The description is minimally adequate but fails to explain what 'details' means, what the return structure looks like, or any error cases. For its low complexity, a score of 3 is acceptable, though there is room for more context.

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 schema fully describes the single parameter alert_id (100% coverage), so the baseline is 3. The description does not add any extra meaning about the parameter, but the schema already provides sufficient clarity.

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 purpose: 'Get details for a specific alert.' It identifies the resource (alert) and action (get details). However, it does not explicitly differentiate from sibling tools such as shodan_alert_list or shodan_alert_delete, so it falls short of a 5.

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 implies usage: use this tool when you have a specific alert ID and need its details. There is no explicit mention of when to use it versus alternatives like shodan_alert_list, or any prerequisites or exclusions. This is implied usage only.

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