Skip to main content
Glama
Sign In
AKHQ MCP Server

AKHQ MCP Server

by seb-noirot
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_groups

Read-onlyIdempotent

List all consumer groups in an Apache Kafka cluster, using optional search and pagination to filter and browse results.

Instructions

List all consumer groups

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>"
    },
    "name": "get_groups"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
searchNo
clusterYesCluster name
perPageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, so the description does not need to repeat safety traits. It adds the entity type and 'all' scope, but gives no detail about pagination, search behavior, or result limits.

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 one short, direct sentence with the action front-loaded. It is concise, though arguably too skeletal to provide meaningful guidance beyond the tool name.

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 read-only listing tool with safety annotations, the description is minimally viable. However, it lacks sibling differentiation, output expectations, and clarification of the three undocumented optional parameters.

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

Parameters2/5

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

Schema description coverage is only 25%, with only 'cluster' documented. The description does not explain page, search, or perPage, and it fails to compensate for the low schema coverage.

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 ('list') and resource ('consumer groups'), and the 'all' scoping distinguishes it from get_group_by_name. It does not explicitly name sibling alternatives, but the core purpose is unambiguous.

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 on when to use this tool versus get_group_by_name, delete_group, or get_group_offsets. The intended usage is only implied by the verb 'list' and the resource name.

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

Deploy Server

Other Tools