kafka_consumer_lag

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

With no annotations, the description carries the full burden. It explains that the tool checks offsets and generates diagnosis based on incident patterns, which is helpful. However, it does not explicitly state that it is read-only, nor does it mention any side effects, rate limits, or error handling. This leaves some behavioral uncertainty.

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 well-structured with a concise opening line followed by bullet points for diagnosis patterns. While it contains detailed incident-specific examples, each sentence adds value. It is not overly verbose but could be slightly tighter.

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 simplicity (one optional parameter) and the presence of an output schema (not shown but indicated), the description provides sufficient context. It covers parameter usage and operational diagnosis, making it complete for an agent to understand and invoke correctly.

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 only parameter 'group' has no description in the schema (0% coverage). The description adds crucial meaning: 'Consumer group ID. Empty = all groups.' This fully clarifies the parameter's purpose and default behavior, compensating for the schema gap.

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: to monitor consumer group lag and provide operational diagnosis. The verb 'Monitor' and resource 'consumer group lag' are specific, and the mention of 'diagnosis' adds clarity. It distinguishes from siblings like kafka_broker_status and kafka_topic_info by focusing on consumer lag.

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 implicitly guides usage by detailing diagnosis patterns for different scenarios (Flink vs non-Flink groups). However, it lacks explicit guidance on when to use this tool over siblings or when not to use it. The context is clear but not exhaustive.

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