Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_serverless_list_backups

Read-only

List automatic backups of a Cloud DB Serverless cluster, showing name, status, and size. Sort or paginate results to review backup history.

Instructions

List automatic backups of a Cloud DB Serverless cluster (GET /mysql/v1/clusters/{clusterName}/backups): name, zoneCode, status (CREATING|AVAILABLE|IN_USE|DELETING), size. Backups are created automatically only — there is no manual create/delete. Sort fields: name, createdDateTime, size.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoSort keys 'field,asc|desc' (repeatable; allowed fields per tool)
pageNoNoPage number, 0-based (default 0 — note: unlike the legacy Ncloud APIs)
pageSizeNoItems per page (1-100, default 20)
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

A3.9/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, so the description adds value by explaining the backup lifecycle (automatic only, no manual create/delete) and the status values. However, it doesn't disclose other behavioral details like pagination behavior or whether the list is filtered by cluster implicitly via the clusterName parameter.

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 compact and information-dense, covering the resource, endpoint, returned fields, backup lifecycle, and sort fields in three sentences. It's slightly dense with the status enum values in parentheses, but each sentence earns its place.

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

Completeness4/5

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

For a read-only list operation with a single required parameter and 100% schema coverage, the description is nearly complete. It covers the essential behavioral context (automatic-only backups), return fields, and sort options. The only minor gap is not explicitly describing the response structure, but no output schema exists and the field list partially covers this.

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 coverage is 100%, so the schema already documents all parameters well. The description adds a note about allowed sort fields (name, createdDateTime, size), which is useful since the sort parameter's description says 'allowed fields per tool'—this tool-specific clarification adds value beyond the generic schema.

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 tool lists automatic backups of a Cloud DB Serverless cluster, with the specific API endpoint, and enumerates the returned fields (name, zoneCode, status, size). It distinguishes itself from related backup tools by noting these are automatic-only backups, setting it apart from manual backup operations.

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 clearly indicates when to use this tool—when listing automatic backups for a serverless cluster—and explicitly notes there is no manual create/delete for these backups, which helps an agent understand the scope. It doesn't explicitly name alternative tools or exclusions, but the context makes the usage scenario clear.

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