Skip to main content
Glama
atengk

mcp-server-kafka

by atengk

kafka_describe_consumer_group

Retrieve active members, partition committed offsets, LEO, and lag for a specified Kafka consumer group to monitor health and diagnose backlog.

Instructions

查询指定 Kafka 消费组的详细拓扑,包含活跃成员、分区 Committed Offset、LEO 及 Lag 积压数值

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
group_idYes
connectionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.3.1

TDQS

B3/5.0
Behavior3/5

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

With no annotations present, the description carries the full behavioral burden. It does disclose the substance of the operation (what data a describe returns), which is useful, but says nothing about read-only nature, permission requirements, cost/latency of a live describe, or behavior for non-existent or inactive groups.

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?

A single front-loaded sentence with no filler, and the key noun ('指定 Kafka 消费组') appears early. It is slightly dense with the trailing enumeration but nothing is wasted.

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?

An output schema exists, so the return shape need not be restated, and the description redundantly previews it. However the two zero-documented parameters and the complete absence of usage guidance leave real gaps for an agent deciding when and how to call it.

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 0%, so both parameters are undocumented in structured form and the description does not compensate. Neither group_id (format, e.g. plain name vs. fully qualified) nor the optional connection parameter is explained anywhere.

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 gives a specific verb ('查询' / describe) plus the exact resource (a designated Kafka consumer group) and even enumerates what the topology view contains: active members, committed offsets, LEO and lag. This clearly separates it from kafka_list_consumer_groups, though the contrast is implicit rather than stated by naming the sibling.

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?

There is no when-to-use / when-not-to-use guidance. It does not say to call this after listing groups, when a group looks lagging, or that it requires an existing group_id, so the agent must infer the usage context from the sibling list alone.

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