Skip to main content
Glama
astandrik

Local YDB MCP

by astandrik
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

local_ydb_upgrade_version

Destructive

Upgrade a local YDB profile to a target image tag while preserving gRPC, monitoring, and IC ports. Preflights images, dumps data, rebuilds nodes, restores, and verifies the final image with rollback on mismatch.

Instructions

Upgrade a file-backed, volume-backed local-ydb profile to a target image tag. Use only for version upgrades on profiles without bindMountPath; before dump or destroy it inspects every one-off dynamic node and preserves its exact gRPC, monitoring, and IC ports, aborting on an incomplete definition. It then preflights source and target images, dumps, rebuilds, restores, reapplies auth when configured, recreates extra nodes, and performs final image verification. A verified mismatch leaves the profile unchanged; if final inventory is unavailable after successful rebuild phases, the response keeps command history, reports partial verification, and persists the target profile image.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
confirmNoMust be true to execute the version upgrade plan. Omit or false for plan-only output.
profileNoNamed profile from local-ydb.config.json. Defaults to config.defaultProfile.
versionYesTarget image tag returned by local_ydb_list_versions.
dumpNameNoOptional dump directory name under profile.dumpHostPath for the upgrade backup.
configPathNoAbsolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.21
    • changedInput schema / properties / configPath / description
      Previous value: -"Explicit local-ydb config file path to load for this tool call. Useful when the MCP server should pick up a different config without restart."New value: +"Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults."
    • addedInput schema / properties / configPath / minLength
      Added value: +1
  2. Changed1 schema field changedv0.1.20
    • changedInput schema / properties / version / description
      Previous value: -"Target image tag such as 26.1.1.6, 26.1, latest, or nightly."New value: +"Target image tag returned by local_ydb_list_versions."
  3. Addedv0.1.12
  4. Removedv0.1.12
  5. Addedv0.1.5
  6. Removedv0.1.4
  7. Changed3 schema fields changedv0.1.1
    • changedInput schema / properties / configPath / description
      Previous value: -"Explicit local-ydb config file path to load for this tool call."New value: +"Explicit local-ydb config file path to load for this tool call. Useful when the MCP server should pick up a different config without restart."
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true to execute commands. Omit or false for plan-only output."New value: +"Must be true to execute the version upgrade plan. Omit or false for plan-only output."
    • addedInput schema / properties / profile / description
      Added value: +"Named profile from local-ydb.config.json. Defaults to config.defaultProfile."
  8. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Goes far beyond the destructiveHint=true annotation by disclosing the full sequence: port preservation, preflight, dump/rebuild/restore, auth reapplication, extra-node recreation, final image verification, and two distinct failure modes. This is exemplary behavioral disclosure for a mutation tool.

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?

Three dense sentences with no wasted words. The scope is front-loaded, and every subsequent clause adds necessary operational or failure-mode detail for a complex destructive procedure.

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?

Covers prerequisites, operation order, port-preservation behavior, abort conditions, and failure branches thoroughly. It does not describe the normal success return payload, but with no output schema and a confirm parameter that already gates plan-only vs execution, this is a minor gap.

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%, so the baseline applies. The description adds contextual color around version and profile but does not introduce new parameter-level semantics for confirm, dumpName, or configPath; the schema already documents those adequately.

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?

States a specific action ('Upgrade'), a precise resource class ('file-backed, volume-backed local-ydb profile'), and a target ('target image tag'). The further restriction to 'version upgrades on profiles without bindMountPath' cleanly distinguishes this from sibling operations like destroy, pull, or restore.

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?

Explicitly restricts usage to version upgrades on profiles without bindMountPath and gives an abort condition for incomplete dynamic-node definitions. It stops short of naming a specific sibling alternative or a broader 'do not use for' set, but the scope is clear enough for correct 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