Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_serverless_get_cluster

Read-only

Retrieve a Cloud DB Serverless cluster's status, endpoints, replica counts, auto scaling, backup configuration, and engine version by providing its cluster name.

Instructions

Get a Cloud DB Serverless cluster (GET /mysql/v1/clusters/{clusterName}): status (CREATING|RUNNING|MODIFYING|PAUSED|DELETING|FAILED), endpoints, unit, replica counts, autoScale, backupConfig, engineVersion.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
clusterNameYesCluster name (3-30 chars, lowercase letters/digits/'-', no leading or trailing '-'; immutable after creation)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.16.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description complements this by listing the exact fields returned (status, endpoints, unit, replica counts, etc.) and the possible status values. It does not contradict the annotation and provides concrete behavioral detail beyond the read-only flag.

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

Conciseness5/5

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

A single sentence, front-loaded with the verb and resource, then followed by the endpoint and returned fields. No wasted words; every element earns its place.

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

Completeness5/5

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

For a single-parameter read-only GET tool with full schema coverage and annotations, the description is complete. It lists the key returned fields, satisfying the need without an output schema, and the tool is simple enough that nothing else is required.

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 the parameter 'clusterName' is fully documented in the schema (format, length, constraints). The description adds no additional meaning about the parameter beyond referencing it in the endpoint. Per rubric, baseline is 3 when schema covers the parameter.

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

Purpose5/5

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

The description clearly states the action ('Get'), the resource ('Cloud DB Serverless cluster'), and the HTTP endpoint, distinguishing it from the sibling list tool by requiring a specific clusterName. It also enumerates the key returned fields, leaving no ambiguity about what the tool does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for retrieving a single cluster by name, as evidenced by the endpoint path. However, it does not explicitly contrast with ncloud_serverless_list_clusters or other alternatives, leaving the when-not-to-use case implicit. This is a minor gap.

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

Deploy Server

Other Tools