reset_consumer_group_offset

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

No annotations provided, so description carries burden. It explains key behaviors: uses AdminClient, defines offset_spec values, dry_run (only calculates), force (override active group). Does not cover error states or idempotency, but sufficient for core behavior.

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 sentences: first states purpose, second details parameters. No fluff, front-loaded, each sentence adds value. Ideal for quick scanning.

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?

Has output schema, so return values not needed. Description covers main behaviors but lacks prerequisites (e.g., group must exist) and side effects. With no annotations, completeness is adequate but not thorough.

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 0% (no parameter descriptions). Description adds meaning for 3 of 6 parameters (offset_spec, dry_run, force) but omits group_id, topic_name, and partition behavior (null = all partitions). Self-explanatory names partially compensate, but incomplete.

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?

Description clearly states the action ('Resets the offset of a consumer group') and resource, with specific parameter explanations (offset_spec, dry_run, force). It distinguishes from sibling tools like 'rewind_consumer_group_offset_by_timestamp' by focusing on manual offset reset rather than timestamp-based.

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?

Description implies usage when resetting offsets to earliest/latest/specific integer but lacks explicit 'when to use' vs. alternatives. No guidance on prerequisites or exclusions, though the offset_spec details give context.

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