cloudwatch_top_ips

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

No annotations provided, so description carries full burden. It does not disclose important behavioral traits such as cost implications, rate limits, permissions needed, scanning limits (max_events cap only in schema), or behavior under heavy log volumes. Only mentions that it parses WAF/ALB structured logs, which is useful but insufficient.

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 concise sentences. First sentence states the core action and resource, second provides context and recommended use case. No fluff or repetition.

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?

No output schema, but description partially describes output (total, allowed, blocked counts). Missing details like return format, ordering, error handling, and behavior when no matching logs. Adequate but not fully complete.

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 all 6 parameters described. The description adds no extra meaning beyond the schema; it does not elaborate on how parameters like action_filter or hours_back interact. Baseline score of 3 is appropriate.

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?

Specific verb 'Rank' + resource 'top client IPs in a CloudWatch log group', and explicitly distinguishes from siblings like cloudwatch_get_log_events by mentioning parsing WAF/ALB logs to aggregate counts.

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?

States 'use it to find abusive IPs before banning', providing clear usage context for abuse detection. Does not explicitly list when not to use, but the purpose is clear enough to differentiate from general log retrieval tools.

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