Skip to main content
Glama
astandrik

Local YDB MCP

by astandrik
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

local_ydb_dump_tenant

Dump a YDB tenant or relative path to a host directory using a local-ydb helper container, excluding system objects; preview the mount and container plan unless confirm is set to true.

Instructions

Dump the configured tenant or a tenant-relative path using a local-ydb helper container on the static container network. It creates profile.dumpHostPath/dumpName, excludes .sys objects, writes the dump under dumpName/tenant, and without confirm=true returns the mkdir/helper-container plan only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoRelative YDB object or directory path to dump inside the configured tenant. Defaults to . for tenant-wide dump semantics.
confirmNoMust be true to dump the tenant. Omit or false for plan-only output.
profileNoNamed profile from local-ydb.config.json. Defaults to config.defaultProfile.
dumpNameNoOptional dump directory name under profile.dumpHostPath.
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. Addedv0.1.12
  3. Removedv0.1.12
  4. Changed1 schema field changedv0.1.11
    • addedInput schema / properties / path
      Added value: +{
+  "description": "Relative YDB object or directory path to dump inside the configured tenant. Defaults to . for tenant-wide dump semantics.",
+  "type": "string"
+}
  5. Addedv0.1.5
  6. Removedv0.1.4
  7. Changed3 schema fields changedv0.1.1
    • addedInput schema / properties / configPath / description
      Added 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."
    • addedInput schema / properties / confirm / description
      Added value: +"Must be true to dump the tenant. 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?

The description discloses concrete side effects beyond annotations: it creates profile.dumpHostPath/dumpName, excludes .sys objects, writes under dumpName/tenant, and returns plan-only output without confirm=true. This gives the agent a strong behavioral model for a mutating operation.

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?

Two dense sentences cover the core capability, output location, exclusions, and confirm behavior with no filler. Every clause adds decision-relevant information.

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?

The description covers the operation, side effects, plan-only behavior, and path layout well. The only gap is that it does not describe what output is returned when confirm=true succeeds, and there is no output schema to fill that gap. Still, the tool is usable without that detail.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and each parameter already has a description, so the baseline is 3. The tool description adds meaningful operational semantics by tying parameters together: the dump location under dumpHostPath/dumpName/tenant and the critical plan-only behavior of confirm. This raises it above baseline.

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 opens with a specific verb and resource: 'Dump the configured tenant or a tenant-relative path'. It clearly distinguishes the tool from siblings like restore_tenant and list_dumps by scope and mechanism, and the behavior is concrete.

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 makes the operational context clear (dump operation, tenant-relative path, plan-only without confirm), but it never states when to prefer this tool over alternatives or mentions sibling tools such as restore_tenant or list_dumps. Usage context is implied rather than explicitly differentiated.

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