Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_serverless_get_imported_backup

Read-only

Retrieve an imported backup's details, showing current import progress through steps from download to finalize and reporting failures.

Instructions

Get one imported backup with import progress (GET /mysql/v1/imported-backups/{backupName}): importProgress.steps DOWNLOAD→EXTRACT→VERIFY→CREATE_BACKUP→FINALIZE, error when FAILED.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
backupNameYesImported backup name (the `name` given at creation)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.16.0

TDQS

A4/5.0
Behavior4/5

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

The readOnlyHint annotation already covers that this is a safe read operation. The description adds useful behavioral context beyond that: it enumerates the exact progress step order (DOWNLOAD→EXTRACT→VERIFY→CREATE_BACKUP→FINALIZE) and specifies the error condition when FAILED. This is extra behavioral detail not present in annotations.

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?

The description is a single, compact sentence that front-loads the core action, then packs the endpoint, progress steps, and error condition without redundancy. Every element 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 single-parameter read tool with a readOnlyHint annotation and no output schema, the description covers the key operational details: what it retrieves (backup with progress), the step lifecycle, and failure indication. It does not detail the full response structure, but that is not essential for a simple get operation.

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% and the parameter description in the schema already explains backupName as the name given at creation. The tool description itself adds minimal semantic value beyond that, essentially confirming the purpose. Baseline 3 is appropriate since the schema carries the burden.

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 states a specific verb ('Get'), a specific resource ('one imported backup'), and adds distinguishing detail: it includes import progress. It also names the endpoint and the exact step sequence, which makes it clear this is for fetching a single backup's status, distinct from listing or creating.

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

Usage Guidelines3/5

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

The description implies when to use this tool (when you need progress for a specific backup) but does not explicitly contrast it with alternatives like ncloud_serverless_list_imported_backups or ncloud_serverless_create_imported_backup. It lacks explicit 'when not to use' or alternative routing.

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