list_alerts

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

No annotations are present, so the description must disclose behavior. It only states 'list alerts' with filters, but does not explain pagination (size, index), sorting ('-created_time'), rate limits, or return format. The lack of output schema makes this omission significant.

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 sentence of 12 words, highly concise and front-loaded with the action and resource. However, it could benefit from additional structure, such as a second sentence on pagination or sorting, to improve clarity without losing conciseness.

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 tool with 9 parameters and no output schema, the description provides insufficient context. It does not explain return values, pagination behavior, sort syntax, or how filters combine. It lacks details needed to use the tool effectively, especially without annotations.

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 has 100% coverage with parameter descriptions. The tool description adds minimal value by naming filter categories (severity, type, status, date range) that are already detailed in the schema. It does not explain parameter interactions or constraints beyond the schema.

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 'List' and resource 'InsightIDR alerts', and mentions optional filters. It distinguishes from sibling tools like 'get_alert' (single alert) and 'search_investigations' (different entity). However, it does not mention all filter parameters (e.g., investigation_id, size, sort).

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?

No guidance is provided on when to use this tool versus alternatives like 'get_alert' or 'search_investigations'. There is no mention of prerequisites, use cases, or exclusions.

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