AKHQ MCP Server

get_group_by_name

Read-onlyIdempotent

Retrieve details for a specific Kafka consumer group using cluster and group names. Access state, offsets, and member info to troubleshoot consumer issues.

Instructions

Get details for a specific 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_by_name"
  }
}

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.3/5.0

Behavior3/5

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

The annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint=false, which covers the safety profile of this read operation. The description adds only the scope of the lookup ('specific consumer group') and does not disclose not-found behavior, error handling, or return shape, 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.

Conciseness5/5

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

The description is a single, front-loaded sentence with no filler or redundancy. It states the action and resource compactly without wasted words.

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?

The tool is a simple two-parameter read operation with full schema descriptions and read-only annotations, so basic invocation is adequately covered. However, because there is no output schema, the vague term 'details' leaves the return payload unspecified, and the description does not mention error behavior or environment/auth prerequisites.

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?

Both parameters, cluster and groupName, are required and have clear schema descriptions, and schema description coverage is 100%. The description adds no additional parameter-level meaning beyond what the schema already provides, so it meets the baseline.

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 ('Get') and resource ('details for a specific consumer group'), making the tool's core purpose obvious. It is distinguishable from get_groups because it targets one named group, but it does not explicitly separate it from related get_group_* tools such as get_group_offsets or get_group_members.

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

Usage Guidelines2/5

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

No guidance is provided about when to use this tool versus alternatives like get_groups or the other get_group_* tools. The word 'specific' implies a by-name lookup, but the description does not state exclusions, prerequisites, or alternatives. The agent must infer usage from the tool name and schema.

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

Deploy Server