incident_snapshot

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

No annotations are provided. The description indicates it returns timestamped data and is a bundle, but lacks details on authentication needs, error handling, or whether individual component failures affect the snapshot.

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 very concise (one sentence and a short phrase), front-loads the key concept ('One-call bundle'), and contains no redundant information.

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?

Given the tool's complexity (bundle of 5 components) and lack of output schema, the description provides only high-level context. It does not specify output format, error behavior, or how the snapshot is assembled, leaving some gaps for the agent.

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 0% description coverage, and the tool description does not explain the parameters 'group' and 'topic' beyond their names, leaving ambiguity about their exact meaning (e.g., consumer group vs. topic).

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 it is a one-call bundle combining cluster health, lag, audit, partition state, and replay readiness, explicitly distinguishing it from the sibling tools that cover each aspect individually.

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 use for postmortems and comprehensive snapshots, and contrasts with sibling tools that provide individual data, but does not explicitly state when not to use this tool or mention alternatives.

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