Skip to main content
Glama
Huawei DCS MCP
by key-well

ShowInstanceTopology

ShowInstanceTopology
Read-onlyIdempotent

Retrieve the topology graph for a DCS Redis cluster instance to inspect shard and node relationships and troubleshoot replication or connectivity issues. Read-only query.

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

Input Schema

NameRequiredDescriptionDefault
regionNoOverrides HUAWEI_REGION.
project_idNoOverrides HUAWEI_PROJECT_ID.
instance_idYes**参数解释**: 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。

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, idempotentHint, and destructiveHint=false, and the phrase '只读查询' merely restates readOnlyHint. The description adds no new behavioral context such as what the topology contains, whether it requires a running cluster, or rate limits. It is not contradictory, but it adds little beyond the annotations.

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 front-loaded phrase with no filler or redundancy. It is concise, though its brevity borders on under-specification rather than tight 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?

With 3 parameters, rich annotations, and full schema coverage, the structured fields carry most of the burden; however, the description still does not explain what the returned topology represents or when it is the right query. For a topology-inspection tool, that leaves a meaningful gap in an otherwise simple surface.

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%, and instance_id, region, and project_id are all documented directly in the schema. The description itself adds no meaning beyond what those fields already provide, so the baseline of 3 is appropriate.

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 cluster instance topology diagram. An agent can distinguish it from general instance readers like ShowInstance or ShowNodesInformation based on the word 'topology.' It doesn't name those siblings explicitly, but its scope is clear.

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 usage cue is '(只读查询)' (read-only query), which describes a mode rather than when to choose this tool. There is no guidance on when to use it versus ShowNodesInformation, ListGroupReplicationInfo, or other instance-detail siblings, and no prerequisites or exclusions.

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