Skip to main content
Glama
sjk4425

ncloud-mcp-server

by sjk4425

ncloud_ses_precheck_upgrade

Pre-check if a Search Engine cluster can be upgraded by confirming a snapshot exists and the target version is valid.

Instructions

Pre-check whether a Search Engine version upgrade can proceed. ⚠️ Requires the cluster to have at least one snapshot — returns 10154 otherwise. Create one with ncloud_ses_create_snapshot, which itself needs ncloud_ses_set_snapshot_api_key set first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
regionNoYesRegion number (from ncloud_get_regions)
targetVersionCodeYesTarget version code (from ncloud_ses_get_versions)
serviceGroupInstanceNoYesCluster instance number

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.15.0
    • addedInput schema / properties / regionNo
      Added value: +{
      +  "description": "Region number (from ncloud_get_regions)",
      +  "type": "number"
      +}
    • removedInput schema / properties / searchEngineVersionCode
      Removed value: -{
      -  "description": "Target version code",
      -  "type": "string"
      -}
    • addedInput schema / properties / targetVersionCode
      Added value: +{
      +  "description": "Target version code (from ncloud_ses_get_versions)",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "serviceGroupInstanceNo",
      -  "searchEngineVersionCode"
      -]New value: +[
      +  "regionNo",
      +  "serviceGroupInstanceNo",
      +  "targetVersionCode"
      +]
  2. First observedv1.10.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations are empty, so the description carries the full behavioral burden. It discloses a failure mode (missing snapshot → 10154) and prerequisite side effects, which is valuable. However, it does not state what the response contains on success or failure beyond the error code, nor explicitly confirm that the precheck itself is read-only, though 'pre-check' implies non-mutating. A 4 is justified given the disclosed error condition and prerequisite dependency.

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 front-loads the purpose in the first sentence, then the critical prerequisite in the second. The warning symbol and error code add value without bloat. Slightly dense with three tool names in one sentence, but each earned 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 precheck gate with no output schema, the description covers purpose, precondition, failure signal, and prerequisite chain. It doesn't explain what a successful precheck returns or how to interpret the response after calling ncloud_ses_upgrade_version, but the core operational knowledge needed to call it correctly is present. The tool appears part of a broader SES workflow, and the description integrates it well.

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%: all three parameters (regionNo, serviceGroupInstanceNo, targetVersionCode) already have descriptions. The description adds context for targetVersionCode via the sibling ncloud_ses_get_versions hint in the schema, but the main description itself does not add new parameter semantics beyond the schema. Baseline 3 is appropriate.

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 ('pre-check') and resource ('Search Engine version upgrade'), and clarifies it is a precheck gate for whether an upgrade can proceed. It also distinguishes the tool from the actual upgrade operation (ncloud_ses_upgrade_version, ncloud_cdss_upgrade_precheck) and from general cluster tools.

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

Usage Guidelines5/5

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

The description explicitly warns that a snapshot is required and names the exact error code (10154) if absent. It also provides the prerequisite chain: create snapshot with ncloud_ses_create_snapshot, which itself requires ncloud_ses_set_snapshot_api_key. This is clear when-to-use and how-to-prepare guidance.

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