Skip to main content
Glama
Huawei RocketMQ MCP

Huawei RocketMQ MCP

by key-well

ShowOneTopic

ShowOneTopic
Read-onlyIdempotent

Retrieve read-only details for a single Huawei Cloud RocketMQ topic by instance ID and topic name to inspect its configuration and support troubleshooting.

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": "ShowOneTopic"
  }
}

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.5/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 description's 'read-only query' is pure repetition. It adds nothing about permissions, error behavior for unknown topics, or what the response looks like.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single phrase is front-loaded and contains no filler, but it is undersized for a tool with four parameters and no output schema. Brevity here comes from omission rather than discipline.

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 simple read tool the annotations and full schema coverage carry most of the load, but with no output schema the description should say something about what is returned or about failure modes. It leaves the agent with only the tool name and a restated read-only hint.

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%, including the note that instance_id is obtained from the instance-list API, so the description is not required to explain parameters. It adds no meaning beyond the schema, which is the baseline expectation here.

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?

The description states a verb and resource ('query a single topic') and marks it read-only, which is enough to know it retrieves one topic. However, it gives no basis for distinguishing it from siblings such as ShowTopicStatus or ListRocketInstanceTopics beyond the word 'single', and it never says what a 'topic' record contains.

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 guidance, no prerequisites (e.g. that instance_id must come from ListInstances), and no mention of alternatives for status or listing operations. The parenthetical '(只读查询)' restates safety rather than routing the agent.

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