Skip to main content
Glama
Huawei RocketMQ MCP

Huawei RocketMQ MCP

by key-well

ListInstances

ListInstances
Read-onlyIdempotent

Retrieves all RocketMQ instances in a Huawei Cloud region, with filters for name, status, and ID returning paginated read-only results so you can inspect and troubleshoot your messaging 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": {
      "engine": "<engine>"
    },
    "name": "ListInstances"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo**参数解释**: 实例名称。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。
limitNo**参数解释**: 当次查询返回的实例最大个数。 **约束限制**: 不涉及。 **取值范围**: 1~50。 **默认取值**: 10。
engineYes**参数解释**: 消息引擎类型。 **约束限制**: 不涉及。 **取值范围**: - rocketmq:RocketMQ引擎。 - reliability:RocketMQ引擎别称。 **默认取值**: 不涉及。
offsetNo**参数解释**: 偏移量,表示从此偏移量开始查询。 **约束限制**: 不涉及。 **取值范围**: 大于等于0。 **默认取值**: 不涉及。
regionNoOverrides HUAWEI_REGION.
statusNo**参数解释**: 实例状态。 **约束限制**: 不涉及。 **取值范围**: [详细状态说明请参考[实例状态说明](hrm-api-0010.xml)。](tag:hws,hws_hk,ctc,hws_eu,ocb,g42,hk_g42,tm,sbc,hk_sbc,cmcc,hk_tm,dt,ax,srg)[详细状态说明请参考[实例状态说明](kafka-api-180514012.xml)。](tag:hcs,fcs,hcs_oemout) **默认取值**: 不涉及。
project_idNoOverrides HUAWEI_PROJECT_ID.
instance_idNo**参数解释**: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。
include_failureNo**参数解释**: 是否返回创建失败的实例数。 **约束限制**: 不涉及。 **取值范围**: - &#39;true&#39;:返回创建失败的实例数。 - &#39;false&#39;:不返回创建失败的实例数。 **默认取值**: 不涉及。
exact_match_nameNo**参数解释**: 是否按照实例名称进行精确匹配查询。 **约束限制**: 不涉及。 **取值范围**: - &#39;true&#39;:表示按照实例名称进行精确匹配查询。 - &#39;false&#39;:表示模糊匹配实例名称查询。 **默认取值**: &#39;false&#39;。
enterprise_project_idNo**参数解释**: 企业项目ID。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.6/5.0
Behavior2/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and "只读查询" merely restates that. Nothing is disclosed about pagination defaults, how limit/offset interact, ordering of results, or what happens when engine-scoped results are empty.

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 short phrase, front-loaded and free of filler or boilerplate. It is efficient, though the brevity reflects under-specification rather than disciplined editing.

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?

This is an 11-parameter list tool with no output schema and no description of result shape, paging behavior, or default page size. For that complexity, one short phrase leaves the agent relying entirely on the schema to understand the call's behavior.

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 detailed per-parameter explanations for name, engine, limit, offset, status, and exact_match_name, so the schema carries the semantics. The description adds no meaning beyond that, which is the baseline 3 case for fully documented schemas.

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

Purpose3/5

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

"查询所有实例列表" gives a verb (query/list) and a resource (instances) with an implicit 'all' scope, so the basic action is graspable. But it essentially restates the tool name ListInstances and offers no differentiation from siblings such as ShowInstance or ListEngineProducts.

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 guidance on when to use this list call versus ShowInstance for a single instance, nor any mention of prerequisites, pagination expectations, or filtering strategy. The parenthetical "只读查询" describes the operation type, not when to choose it over an alternative.

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