Skip to main content
Glama

local_ydb_dump_tenant

Dump a YDB tenant or relative path using a local-ydb helper container. Excludes system objects and returns a plan unless confirmed.

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
profileNoNamed profile from local-ydb.config.json. Defaults to config.defaultProfile.
configPathNoExplicit local-ydb config file path to load for this tool call. Useful when the MCP server should pick up a different config without restart.
confirmNoMust be true to dump the tenant. Omit or false for plan-only output.
dumpNameNoOptional dump directory name under profile.dumpHostPath.
pathNoRelative YDB object or directory path to dump inside the configured tenant. Defaults to . for tenant-wide dump semantics.
Behavior4/5

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

Adds behavioral context beyond annotations: uses helper container on static network, excludes .sys objects, writes dump at specific path, and explains plan-only mode. Annotations only indicate readOnly=false, destructive=false, idempotent=false, openWorld=true, so description adds value.

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?

Single sentence packs substantial detail, front-loaded with the main action. Could be slightly clearer if split, but remains concise and informative.

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 tool with 5 params and no output schema, description covers key behavioral aspects. Lacks mention of container dependencies or how dump is used, but sufficient for basic usage.

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 baseline is 3. Description adds minimal extra context about confirm behavior and dump path, but mostly restates schema info.

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?

Description clearly states it dumps a configured tenant or tenant-relative path using a specific helper container, with details like excluding .sys objects and plan-only mode. It distinguishes itself from siblings like local_ydb_restore_tenant.

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?

Description explains the confirm flag for plan-only vs actual dump, but does not specify when to use this tool over alternatives like local_ydb_list_dumps or local_ydb_restore_tenant. No when-not or comparative guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/astandrik/local-ydb-toolkit'

If you have feedback or need assistance with the MCP directory API, please join our Discord server