AKHQ MCP Server

get_group_offsets

Read-onlyIdempotent

Retrieve the current offsets for a consumer group to analyze consumption progress and identify lag.

Instructions

Get offsets for a consumer group

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "cluster": "<cluster>",
      "groupName": "<groupName>"
    },
    "name": "get_group_offsets"
  }
}

Input Schema

Name	Required	Description	Default
`cluster`	Yes	Cluster name
`groupName`	Yes	Consumer group name

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Sep 5, 2026

TDQS

B3.4/5.0

Behavior3/5

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

The annotations already establish readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the read-only nature is covered. The description adds no further behavioral context, such as behavior for unknown groups, whether results include per-partition details, or whether any data is returned incrementally, but it does not contradict the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence with no filler. Every word contributes to the core meaning, though the brevity leaves some context implicit.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter read tool with supportive annotations, this is minimally complete: an agent knows the operation is safe and needs only cluster and groupName. However, there is no output schema and the description does not describe the return shape, leaving ambiguity about what offsets data will be returned.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with cluster described as 'Cluster name' and groupName as 'Consumer group name.' The description adds no additional parameter semantics beyond what the schema already provides, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear verb and resource: 'Get offsets for a consumer group.' It also distinguishes this tool from sibling group tools such as get_group_by_name, get_group_members, and get_group_topics by naming offsets specifically. It is not a full tautology, though it stays very close to the tool name and does not detail what form the offsets take.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied: an agent can infer to use this when it needs the offsets of a consumer group. However, the description gives no explicit guidance about when not to use it, nor does it mention alternatives such as post_group_offsets for writing offsets or get_group_by_name for group metadata.

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

Deploy Server