oci_kafka_get_consumer_lag

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

No annotations are provided, so the description carries the full burden. It states the tool is a read operation ('Get') and describes returned data, but does not disclose potential errors, authentication requirements, or behavior when the group_id is invalid. This is adequate for a straightforward retrieval tool but lacks depth.

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 concise, with four sentences each serving a purpose: purpose, parameter, return value, and usage. No wasted words.

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 simplicity of the tool (one parameter, output schema exists), the description covers the essentials: what it does, what parameter is needed, and what is returned. It could mention that it works across all assigned partitions, which it does, and provides a practical use case. Minor gap: no mention of pagination or limit, but not needed for this tool.

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 description coverage is 0%, so the description must compensate. It fully explains the only parameter group_id: 'The consumer group ID to check lag for.' This adds necessary meaning that the schema alone does not provide.

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 ('Get consumer lag') and the resource ('for a consumer group across all assigned partitions'). It effectively distinguishes from sibling tools like oci_kafka_describe_consumer_group (group metadata) and oci_kafka_reset_consumer_offset (mutating offset).

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 provides a clear use case: 'Use this to diagnose slow consumers or processing bottlenecks.' However, it does not explicitly mention when not to use it or provide alternatives among sibling tools, which would improve clarity.

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