Skip to main content
Glama
Huawei RocketMQ MCP

Huawei RocketMQ MCP

by key-well

ListInstanceConsumerGroups

ListInstanceConsumerGroups
Read-onlyIdempotent

Retrieves the consumer groups for a specified RocketMQ instance with optional filtering and pagination, without modifying any resources.

Instructions

查询消费组列表(只读查询)

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": {
      "instance_id": "<instance_id>"
    },
    "name": "ListInstanceConsumerGroups"
  }
}

Input Schema

NameRequiredDescriptionDefault
groupNo**参数解释**: 消费组名称。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。
limitNo**参数解释**: 查询数量。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 10。
offsetNo**参数解释**: 偏移量,表示从此偏移量开始查询。 **约束限制**: 不涉及。 **取值范围**: 大于等于0。 **默认取值**: 0。
regionNoOverrides HUAWEI_REGION.
project_idNoOverrides HUAWEI_PROJECT_ID.
instance_idYes**参数解释**: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

The annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint, so 只读查询 only restates that this is a read-only operation. The description adds nothing beyond the annotations, such as whether results are paginated, the default page size, or how the group filter behaves.

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 short phrase with no wasted wording and leads with the core purpose. Its brevity borders on under-specification rather than redundancy, but it is structurally clean.

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

Completeness2/5

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

For a 6-parameter, open-world list tool whose only required input is instance_id, this one-line description is very thin. Together with the lack of an output schema, it leaves the return shape and filtering behavior unexplained, though the rich schema offsets some of this gap.

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%, so the schema already documents all six parameters, including instance_id retrieval and the meaning of limit and offset. The description adds no extra meaning, so the baseline of 3 applies when the schema does the work.

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 clear verb and resource in 查询消费组列表, so the agent can tell it lists consumer groups. It does not contrast this tool with nearby tools such as ListConsumerGroupOfTopic or ShowConsumerListOrDetails, so the agent cannot infer when to use this tool rather than those.

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?

The only guidance is the parenthetical 只读查询, which is a safety note, not guidance about when to use the tool. The description does not mention alternatives, prerequisites for the instance_id (such as how to obtain it), or pagination context.

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