Skip to main content
Glama
Huawei RocketMQ MCP

Huawei RocketMQ MCP

by key-well

ShowTopicStatus

ShowTopicStatus
Read-onlyIdempotent

Queries the message count for a specified RocketMQ topic in an instance to support read-only status checks and backlog monitoring.

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

Input Schema

NameRequiredDescriptionDefault
topicYes**参数解释**: 主题名称。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。
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?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the '(只读查询)' note merely restates what structured data already says. The description adds nothing about what the response contains (total count vs. per-partition counts), whether data is live or lagging, or what happens for a nonexistent topic.

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?

It is a single short sentence with zero redundant wording, and the core purpose is front-loaded. It is terse to the point of being minimal, but nothing is wasted or buried.

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?

With four parameters, no output schema, and a status-style return value, the description should explain at minimum what the count represents and how it is returned. As written, an agent knows only the general intent and nothing about the result shape or edge cases.

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 explains topic, instance_id, region, and project_id, including how to obtain the instance ID. The description adds no parameter meaning beyond that, which is the expected baseline 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 states a specific verb and resource: querying the message count for a topic (查询主题的消息数). That is more precise than the name alone, but it does not differentiate this tool from siblings such as ShowOneTopic or ListRocketInstanceTopics that also operate on topics.

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 tool rather than a sibling, no prerequisites (e.g., that the instance must exist or be reachable), and no exclusions. The agent must infer usage from the name and the parenthetical.

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