Каталог MCP
astandrik/local-ydb-toolkit

astandrik/local-ydb-toolkit

Name: astandrik/local-ydb-toolkit
Availability: InStock
Author: astandrik

MCP-сервер для управления Docker-инстансами local-ydb: создание тестовых YDB баз, управление схемами, дамп и восстановление. Полезен разработчикам для локального тестирования и CI на GitHub Actions.

README

39 инструментов

Версии

Установить сервер

local-ydb-toolkit

Toolkit for operating local-ydb deployments across Codex, MCP clients, and GitHub Actions CI.

Website: local-ydb-toolkit.ydb-qdrant.tech.

It includes:

a reusable Codex skill for local and SSH local-ydb operations;
an unofficial local stdio MCP server published as @astandrik/local-ydb-mcp;
a Marketplace GitHub Action, astandrik/setup-local-ydb, for booting disposable YDB tenants in CI.

Discovery and trust

Full listing hub: local-ydb-toolkit.ydb-qdrant.tech/#mcp-registries.

Surface	Badges
Official registries and lists
Trust and audit
MCP directories

Relationship to `ydb/ydb-mcp`

Local YDB MCP is complementary to the official ydb-platform/ydb-mcp server. Use ydb/ydb-mcp when an agent needs general YDB database-level tools such as ad hoc SQL queries, query explanations, directory listing, and path inspection against an existing YDB endpoint.

Use this toolkit when the agent needs to operate Docker-based local-ydb environments themselves: host prerequisite checks, root or tenant bootstrap, dynamic-node lifecycle, GraphShard checks, table DDL generation/validation/application for local deployments, auth hardening, storage workflows, dump/restore, and version upgrades. Mutating MCP tools are plan-first and require confirm: true before they execute changes.

Инструменты были проиндексированы: 09.09.2026

local_ydb_add_dynamic_nodesвнешний мир

Добавляет одноразовые динамические узлы tenant поверх декларативной топологии profile.dynamicNodeCount, по одному за раз. По умолчанию первый суффикс — dynamicNodeCount + 1; явный startIndex должен быть больше dynamicNodeCount, переназначение портов остаётся доступным. Каждое запланированное имя должно отличаться от статического контейнера, и все настроенные и одноразовые порты должны быть корректны и уникальны в общем сетевом пространстве имён. После каждой проверки наличия образа повторяет полную предварительную проверку статической совместимости в режиме только проверки, включая текущий идентификатор образа, непосредственно перед запуском каждого узла; несовпадение останавливает этот узел и все последующие, требуется уничтожить и пересобрать. Каждый динамический контейнер создаётся, но не запускается, пока его разрешённый идентификатор образа не совпадёт со статическим контейнером — это закрывает состояние гонки при одновременном обновлении именованного тега. Без confirm=true возвращает планы контейнеров и портов; с confirm=true каждый узел должен иметь стабильно запущенный точный Docker-контейнер и его порт IC в viewer/json nodelist, прежде чем проверяются метаданные tenant.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
countinteger
Number of additional dynamic nodes to add. Defaults to 1.
grpcPortStartinteger
gRPC port for the first added node. Defaults to profile.dynamicGrpc + startIndex - 1.
icPortStartinteger
Interconnect port for the first added node. Defaults to profile.dynamicIc + startIndex - 1.
monitoringPortStartinteger
Monitoring port for the first added node. Defaults to profile.dynamicMonitoring + startIndex - 1.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
startIndexinteger
Suffix for the first added container. It must be greater than profile.dynamicNodeCount. Defaults to profile.dynamicNodeCount + 1, producing <dynamicContainer>-<dynamicNodeCount + 1>.

local_ydb_add_storage_groupsвнешний мир

Увеличивает NumGroups для одного пула хранения арендатора, используя текущее определение ReadStoragePool. Без confirm=true эта операция возвращает план DefineStoragePool, откат, целевой пул и целевое количество; когда обновление выполнено успешно, она проверяет NumGroups и метаданные арендатора.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
countinteger
Number of storage groups to add. Defaults to 1.
poolNamestring
Explicit storage pool name. Defaults to <tenantPath>:<storagePoolKind>.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_apply_auth_hardeningвнешний мир

Применяет проверенный укрепленный конфигурационный файл YDB только после того, как полная проверка статического профиля в режиме только проверки (check-only) и проверка совместимости настроенных привязок (configured-binding compatibility preflight) пройдут успешно до любых изменений конфигурации или контейнера; неизменяемые несоответствия требуют уничтожения (destroy) с последующей перезагрузкой (bootstrap). Затем перезапускает статический узел и заново создает и проверяет каждый настроенный динамический узел в порядке индекса, даже если файл токена динамического узла не настроен. Стабильность работы Exact-container и регистрация IC должны пройти успешно до проверки метаданных, а откат использует перезапуск или согласование при загрузке (bootstrap reconciliation) после восстановления статической конфигурации. Использует только после подготовки и проверки конфигурации; без confirm=true возвращает только план preflight/apply/recreate.

Параметры

configHostPathstring
Reviewed config.yaml path on the selected target host. Defaults to profile.authConfigPath when present.
configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to apply the auth hardening config and restart local-ydb. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_apply_schemaвнешний мир

Проверяет или применяет DDL таблиц YDB через официальный YDB JS SDK. Принимает сырой YQL DDL для PRAGMA, а также CREATE TABLE, ALTER TABLE и DROP TABLE; action=apply сначала проверяет, а выполняет только при confirm=true.

Параметры

actionenum
Schema operation to run. validate only checks the YQL DDL through the YDB SDK; apply validates first and executes only with confirm=true.
configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute action=apply after SDK validation succeeds. Omit or false for validation plus plan-only output.
databasePathstring
YDB database path for SDK validation/application. Defaults to the configured tenant root; root database paths use the static gRPC port.
maxOutputBytesinteger
Maximum UTF-8 bytes returned per validation/execution issue stream. Defaults to 65536.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
scriptstringобязательный
YQL DDL script to validate or apply. Supports PRAGMA plus CREATE TABLE, ALTER TABLE, and DROP TABLE statements.
timeoutMsinteger
SDK operation timeout in milliseconds. Defaults to 120000.

local_ydb_auth_checkтолько чтениеидемпотентныйвнешний мир

Аудит аутентификации только для чтения — проверяет статус whoami анонимного просмотрщика и настроенный доступ к тенанту YDB CLI, используя root-учётные данные, когда настроен rootPasswordFile. Используйте после усиления аутентификации или смены пароля, чтобы проверить ожидаемое состояние.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_bootstrapидемпотентныйвнешний мир

Создаёт топологию тенанта: статический узел с флагами GraphShard и loopback-б индингами для статического и каждого настроенного динамического gRPC-порта, настроенный CMS-тенант и все динамические узлы, объявленные через profile.dynamicNodeCount. Перед возвратом или выполнением плана имена настроенных контейнеров должны отличаться от статического контейнера, а все порты shared-network должны быть корректными и уникальными. Узлы запускаются в порядке индексов; перед запуском следующего узла готовность требует, чтобы точный Docker-контейнер был запущен, не перезапускался, был стабильным по container ID и RestartCount на протяжении двух проверок и зарегистрирован по своему IC-порту в viewer/json nodelist. Существующий запущенный или остановленный статический контейнер повторно используется только после полной проверки совместимости профилей, включая каждое настроенное gRPC-связывание. Используйте только для сценариев с тенантом, GraphShard, dump/restore или динамическими узлами; без confirm=true возвращает полный план и ничего не создаёт.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_bootstrap_root_databaseидемпотентныйвнешний мир

Разворачивает простую локальную базу данных YDB в /local только со статическим узлом. Используется для обычных запросов к локальной базе, которым не нужен арендатор CMS, GraphShard или динамические узлы; без confirm=true возвращает префлайт образа, сеть Docker/хранилище/статический узел и план проверки без выполнения.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_check_prerequisitesидемпотентныйвнешний мир

Проверяет предварительные требования целевого хоста для Docker, curl, ruby и настроенного rootPasswordFile, если он присутствует. Без confirm=true возвращает проверки, отсутствующие элементы, ручные действия и любой план установки apt-get; с confirm=true может устанавливать только поддерживаемые пакеты curl/ruby и никогда не устанавливает Docker.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_cleanup_storageвнешний мир

Удаляет только явно указанные host-пути local-ydb или Docker-тома. Используйте после проверки local_ydb_storage_leftovers; без confirm=true возвращает план очистки и ничего не удаляет.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to remove the explicitly supplied storage paths or Docker volumes. Omit or false for plan-only output.
pathsstring[]
Explicit host filesystem paths to remove. Nothing is deleted unless each path is supplied here and confirm=true.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
volumesstring[]
Explicit Docker volume names to remove. Nothing is deleted unless each volume is supplied here and confirm=true.

local_ydb_container_logsтолько чтениеидемпотентныйвнешний мир

Читает последние логи Docker из настроенного статического или основного динамического контейнера local-ydb. Используйте, когда загрузка, перезапуск или проверки готовности завершаются с ошибкой; target выбирает роль контейнера, а lines управляет количеством строк в конце.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
linesinteger
Number of recent log lines to read. Defaults to 200.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
targetenumобязательный
Container role to read logs from: static node or primary dynamic tenant node.

local_ydb_create_tenantидемпотентныйвнешний мир

Создаёт настроенного тенанта CMS, когда статический узел уже запущен. Используется перед local_ydb_start_dynamic_node для топологий тенантов; без confirm=true это возвращает запланированный статус/команду создания и ничего не создаёт.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_database_statusтолько чтениеидемпотентныйвнешний мир

Статус админской базы данных YDB только для чтения для заданного пути тенанта. Возвращает команду, stdout, stderr и флаг ok; используйте это для проверки состояния тенанта перед устранением неполадок при загрузке/перезапуске, а для проверки доступности схемы используйте local_ydb_tenant_check.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_destroy_stackвнешний мир

Удаляет метаданные тенанта, контейнеры local-ydb, сеть и хранилище для профиля, с опциональной очисткой путей хоста.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
removeAuthArtifactsboolean
Delete explicit authConfigPath, dynamicNodeAuthTokenFile, and rootPasswordFile when configured. Defaults to false.
removeBindMountPathboolean
Delete profile.bindMountPath when the profile uses a bind mount. Defaults to false.
removeDumpHostPathboolean
Delete profile.dumpHostPath. Defaults to false because it may be shared.

local_ydb_dump_tenantвнешний мир

Выгружает настроенный тенант или путь относительно тенанта, используя вспомогательный контейнер local-ydb в статической контейнерной сети. Создаёт profile.dumpHostPath/dumpName, исключает объекты .sys, записывает дамп в dumpName/tenant, а без confirm=true возвращает только план mkdir/helper-container.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to dump the tenant. Omit or false for plan-only output.
dumpNamestring
Optional dump directory name under profile.dumpHostPath.
pathstring
Relative YDB object or directory path to dump inside the configured tenant. Defaults to . for tenant-wide dump semantics.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_generate_schemaтолько чтениеидемпотентныйвнешний мир

Генератор DDL для таблиц YDB в режиме только для чтения. Он формирует строгие JSON-спецификации для CREATE TABLE, ALTER TABLE, DROP TABLE и вторичных индексов, возвращает сгенерированный скрипт с официальными ссылками и предупреждениями, а при необходимости может выполнить проверку через YDB JS SDK без применения изменений.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
databasePathstring
YDB database path to use when validate=true. Defaults to the configured tenant root.
maxOutputBytesinteger
Maximum UTF-8 bytes returned per validation issue stream when validate=true. Defaults to 65536.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
statementsobject[]обязательный
Structured schema statement specs to render into YDB table DDL.
timeoutMsinteger
SDK validation timeout in milliseconds when validate=true. Defaults to 120000.
validateboolean
If true, validate the generated DDL through local_ydb_apply_schema action=validate. This tool never applies DDL.

local_ydb_graphshard_checkтолько чтениеидемпотентныйвнешний мир

Проверка GraphShard только для чтения через возможности viewer/json и tabletinfo для настроенного тенанта. Возвращает graphShardExists, идентификаторы таблеток и детали статуса viewer; используйте после начальной настройки тенанта, когда конкретный вопрос касается поддержки GraphShard или видимости таблеток.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_healthcheckтолько чтениеидемпотентныйвнешний мир

Только для чтения проверка работоспособности YDB для настроенного тенанта или корневой базы данных. Использует официальный путь SelfCheck CLI YDB, возвращает selfCheckResult, количество проблем, типы проблем, усечённый сырой вывод и информацию о том, здорова ли база данных; запрошенная опция noCache/noMerge отклоняется, точная распознанная двухстрочная сигнатура устаревшего парсера сообщается через optionResolution и warnings, а compatibilityFallback показывает, действительно ли началась повторная попытка. Используйте после local_ydb_status_report для диагностики на уровне базы данных.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
databasePathstring
YDB database path to check. Defaults to the configured tenant path; only the configured tenant path or root database path are accepted.
maxIssuesinteger
Maximum number of issue_log entries returned in the issues field. Counts still cover the full response. Defaults to 100.
maxOutputBytesinteger
Maximum UTF-8 bytes returned per raw stdout/stderr stream. Defaults to 65536.
noCacheboolean
Request cache-bypass semantics for this healthcheck. Newer YDB CLIs receive --no-cache. A rejection matching the exact recognized two-line legacy parser signature is recorded in optionResolution and warnings; when the shared deadline permits an actual retry without that option, compatibilityFallback is true.
noMergeboolean
Request unmerged healthcheck issue entries. Newer YDB CLIs receive --no-merge. A rejection matching the exact recognized two-line legacy parser signature is recorded in optionResolution and warnings; when the shared deadline permits an actual retry without that option, compatibilityFallback is true.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
timeoutMsinteger
Server-side YDB healthcheck timeout in milliseconds. Defaults to 120000.

local_ydb_inventoryтолько чтениеидемпотентныйвнешний мир

Инвентаризация Docker только для чтения для целевого профиля local-ydb. Возвращает публичный профиль, контейнеры и тома Docker, видимые на выбранной цели, а также данные inspect для настроенных статических и основных динамических контейнеров; используйте перед инструментами, изменяющими состояние, чтобы зафиксировать текущее состояние стека.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_list_dumpsтолько чтениеидемпотентныйвнешний мир

Список доступных дампов тенантов по пути profile.dumpHostPath только для чтения. Используйте перед восстановлением, чтобы выбрать dumpName; он сообщает только о каталогах дампов верхнего уровня, содержащих существующую папку дампа тенанта.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_list_versionsтолько чтениеидемпотентныйвнешний мир

Перечисляет опубликованные теги GHCR или Docker Hub для образа контейнера local-ydb, причём числовые теги версий сортируются от новых к старым. Используется перед local_ydb_upgrade_version. Пагинация и аутентификация реестра ограничены доверенными источниками, а pageSize и maxPages ограничивают пагинацию.

Параметры

imagestring
GHCR or Docker Hub container image name to inspect. Defaults to ghcr.io/ydb-platform/local-ydb.
maxPagesinteger
Maximum number of registry pages to fetch before truncating the result. Defaults to 10.
pageSizeinteger
Requested tags per registry page. Defaults to 100.

local_ydb_nodes_checkтолько чтениеидемпотентныйвнешний мир

Проверка регистрации динамических узлов в режиме только для чтения через viewer/json nodelist. Используйте после запуска, добавления или удаления динамических узлов; сначала используйте local_ydb_tenant_check, если доступность тенанта неизвестна.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_permissionsвнешний мир

Проверить или изменить права доступа к схеме YDB для пути. Действие list по умолчанию — только чтение; grant, revoke, set, clear, chown и изменения наследования возвращают план, за исключением случаев, когда confirm=true.

Параметры

actionenum
Permissions operation to run. Defaults to list, which is read-only and does not require confirm.
configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute mutating actions. Omit or false for plan-only output. Not required for action=list.
maxOutputBytesinteger
For action=list, maximum UTF-8 bytes returned per stdout/stderr stream. Defaults to 65536.
ownerstring
New owner for action=chown.
pathstring
Scheme path to manage. Defaults to the configured tenant root.
permissionsstring[]
Permission names for grant, revoke, and set actions. Each item is passed as its own -p argument.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
subjectstring
User or group subject for grant, revoke, and set actions.

local_ydb_prepare_auth_configвнешний мир

Генерирует hardened-конфигурацию YDB из текущей static-node конфигурации. Используйте перед local_ydb_write_dynamic_auth_config и local_ydb_apply_auth_hardening; без confirm=true этот инструмент возвращает только запланированную запись.

Параметры

configHostPathstring
Host path for the generated hardened config. Defaults to profile.authConfigPath when present.
configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to write the hardened config file. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
sidstring
SID to place into viewer, monitoring, administration, and register_dynamic_node_allowed_sids. Defaults to profile.dynamicNodeAuthSid or root@builtin.

local_ydb_pull_imageвнешний мир

Планирует или запускает фоновую загрузку Docker образа local-ydb на выбранной цели. Без confirm=true возвращает только команды inspect и pull; с confirm=true возвращает jobId для local_ydb_pull_status, если образ ещё не присутствует.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to start the background Docker pull. Omit or false for plan-only output.
imagestring
Container image to pull. Defaults to the selected profile image.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_pull_statusтолько чтениеидемпотентныйвнешний мир

Проверяет статус фоновой загрузки образа Docker, запущенной с помощью local_ydb_pull_image. Для известных задач возвращает монотонный progressPercent, основанный на загруженных известных слоях Docker, а не на байтах: 0-99 при выполнении, 100 после успешного завершения и последнее наблюдаемое значение после сбоя.

Параметры

jobIdstringобязательный
Background pull job id returned by local_ydb_pull_image.

local_ydb_reduce_storage_groupsвнешний мир

Уменьшает NumGroups для пула хранения арендатора: делает дамп арендатора, перестраивает стек профилей с меньшим storagePoolCount, восстанавливает дамп и при необходимости повторно применяет аутентификацию. Перед дампом или удалением проверяет каждый отдельный динамический узел и сохраняет его точные порты gRPC, мониторинга и IC; неполное определение прерывает перестроение.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
countinteger
Number of storage groups to remove from the current tenant pool. Defaults to 1.
dumpNamestring
Optional dump directory name under profile.dumpHostPath to preserve before rebuild.
poolNamestring
Explicit storage pool name. Defaults to <tenantPath>:<storagePoolKind>.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_remove_dynamic_nodesвнешний мир

Удаляйте динамические суффиксы узлов tenant по одному и проверяйте исчезновение из nodelist, когда IC-порт узла удаётся разрешить. Без containers, nodeIds или startIndex подходят только разовые суффиксы, превышающие profile.dynamicNodeCount, и первым удаляется самый старший суффикс. Явные селекторы или startIndex могут удалить настроенный суффикс и вызвать расхождение, которое исправляется загрузкой (bootstrap) или перезапуском (restart). Рекомендации по откату: для настроенных узлов — bootstrap/restart, для разовых — add_dynamic_nodes с соответствующими суффиксами и портами. Основной dynamicContainer всегда защищён.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
containersstring[]
Explicit suffix dynamic-node container names to remove. Configured suffixes can be selected and become runtime drift; the profile's primary dynamicContainer remains protected.
countinteger
Number of dynamic nodes to remove when containers and nodeIds are omitted. Defaults to 1.
nodeIdsinteger[]
Explicit YDB dynamic-node IDs to remove. IDs may resolve to configured or one-off suffix containers; the profile's primary dynamicContainer is not removable through this option.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
startIndexinteger
Minimum suffix to consider removable. Without explicit containers or nodeIds, defaults to profile.dynamicNodeCount + 1 so configured suffixes are excluded. Explicit selectors default to 2. An explicit startIndex always overrides either default.

local_ydb_restart_stackвнешний мир

Выполняет сверку и перезапускает выбранный профиль после инвентаризации и полной предварительной проверки статической совместимости в режиме только проверки. Перед остановкой любого контейнера требует, чтобы существующий статический контейнер соответствовал образу профиля, сети, точке монтирования данных, окружению, политике перезапуска, healthcheck и точным привязкам loopback для статического gRPC, мониторинга и каждого настроенного динамического порта gRPC; изменения настроенных привязок требуют уничтожения с последующей начальной загрузкой. Затем сообщает об отсутствующих настроенных и неожиданных одноразовых динамических контейнерах, останавливает работающие динамические контейнеры до статических, безусловно воссоздаёт каждый настроенный узел в порядке индекса, включая контейнеры, замеченные при перезапуске, требует, чтобы каждый точный Docker-контейнер стабильно работал и был зарегистрирован по порту IC, и восстанавливает только ранее работавшие неожиданные контейнеры, не удаляя их. Поскольку удалённые настроенные определения невозможно восстановить из инвентаризации, откат использует сверку при перезапуске или начальной загрузке. Без confirm=true возвращает только план перезапуска.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_restore_tenantвнешний мир

Восстанавливает настроенный тенант или путь назначения из дампа по адресу profile.dumpHostPath, с возможностью описать схему после восстановления и выполнить проверку с ограниченным подсчётом запросов. Используйте после начальной загрузки или пересборки, когда целевой тенант готов; без confirm=true эта команда возвращает план восстановления и не записывает данные.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to restore the tenant from the selected dump. Omit or false for plan-only output.
countQueriesobject[]
Optional bounded whole-table SELECT COUNT(*) or COUNT(1) queries to verify restored data after the restore command.
describePathsstring[]
Optional tenant-relative paths to verify with scheme describe after the restore command.
dumpNamestringобязательный
Dump directory name under profile.dumpHostPath.
pathstring
Destination directory path for YDB tools restore -p, relative to the configured tenant. Defaults to . for tenant root.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_schemeтолько чтениеидемпотентныйвнешний мир

Список или описание схемы YDB только для чтения с ограничением stdout/stderr. Использует корневую базу данных для путей rootDatabase и базу данных тенанта в остальных случаях; list поддерживает флаги recursive/long/onePerLine, describe поддерживает stats, и несовместимые комбинации флагов отклоняются.

Параметры

actionenum
Scheme operation to run. Defaults to list.
configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
longboolean
For action=list, pass -l for detailed object attributes.
maxOutputBytesinteger
Maximum UTF-8 bytes returned per stdout/stderr stream. Defaults to 65536.
onePerLineboolean
For action=list, pass -1 to print one object per line.
pathstring
Scheme path to inspect. Defaults to the configured tenant root.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
recursiveboolean
For action=list, pass -R to recursively list subdirectories.
statsboolean
For action=describe, pass --stats.

local_ydb_set_root_passwordвнешний мир

Вращайте пароль корневого пользователя времени выполнения с помощью ALTER USER и синхронизируйте конфигурацию аутентификации хоста и файл пароля корневого пользователя для соответствия. YDB может отклонить пароли, нарушающие auth_config.password_complexity; этот инструмент требует непустого значения пароля.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to rotate and persist the root password. Omit or false for plan-only output.
passwordstringобязательный
New non-empty root password without carriage returns or newlines to apply to the runtime root user and then persist into the host auth config and root password file. YDB defaults to no password complexity requirements, but the selected cluster may still reject the value when auth_config.password_complexity is configured.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_sqlвнешний мир

Выполняет управляемый YQL v1 для настроенной цели local-ydb через Query Service. query использует SnapshotRO, explain возвращает план/AST, а execute всегда сначала выполняет EXPLAIN и отправляет только одно выполнение NoTx с confirm=true.

Параметры

actionenum
Managed YQL action. query uses SnapshotRO, explain returns plan/AST without execution, and execute always EXPLAIN-preflights before optional confirmed NoTx execution.
configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Considered only for action=execute. Must be true to send one NoTx execution after successful EXPLAIN; query remains SnapshotRO even when true.
databasePathstring
Configured tenant or root database path. Defaults to the selected profile tenant path; root paths use the static gRPC port.
maxOutputBytesinteger
Shared retained-output budget for issues, plan/AST, columns, and rows.
maxRowsinteger
Maximum retained rows per result set. The first limit hit stops all further result capture: read-only execution is cancelled, while confirmed NoTx execution drains without capturing later output.
parametersobject
Typed YQL parameters keyed by bare name. The request is limited to 100 parameters, 1,000 descriptor nodes, 10,000 value nodes, and 1 MiB of serialized parameter data. Struct field names must be well-formed Unicode. Values use the documented JSON representation and are never echoed in response metadata. Json/JsonDocument numbers must be finite, integer values must be JavaScript safe integers, and negative zero is rejected because JSON encoding cannot preserve its sign.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
scriptstringобязательный
Well-formed-Unicode YQL v1 script; lone UTF-16 surrogates are rejected. Parameter DECLARE statements are generated from parameters and prepended before execution.
timeoutMsinteger
Single deadline in milliseconds shared by connection, session, preflight, execution, and cancellation.

local_ydb_start_dynamic_nodeидемпотентныйвнешний мир

Запускает настроенный первичный динамический узел-тенант для существующего CMS-тенанта. Перед возвратом или выполнением плана отклоняет первичное имя, которое ссылается на статический контейнер, и порты, конфликтующие в общем сетевом пространстве имен, включая статический IC-порт 19001. После проверки наличия образа выполняет полную статическую проверку совместимости (только проверка, без запуска), включая текущий ID образа, непосредственно перед запуском динамического контейнера; несоответствие приводит к закрытой ошибке, требующей уничтожения с последующей загрузкой. Динамический контейнер создается, но не запускается, пока его разрешенный ID образа не совпадет с ID статического контейнера, что закрывает гонку конкурентного обновления именованного тега. Используйте после local_ydb_create_tenant или когда статус администратора — PENDING_RESOURCES; используйте local_ydb_add_dynamic_nodes для дополнительных узлов. Без confirm=true возвращает только план.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute planned commands. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_status_reportтолько чтениеидемпотентныйвнешний мир

Агрегированный отчёт только для чтения для быстрой диагностики. Запускает local_ydb_inventory, local_ydb_auth_check, local_ydb_tenant_check, local_ydb_nodes_check и local_ydb_healthcheck, возвращая каждый результат; используйте его в первую очередь для оценки общего состояния стека, затем выполняйте целенаправленные проверки для статуса баз данных, GraphShard, хранилища или логов.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_storage_leftoversтолько чтениеидемпотентныйвнешний мир

Поиск только для чтения оставшихся локальных Docker-томов local-ydb, дампов и путей PDisk/data. Сканирует имена Docker-томов и profile.storageSearchPaths, ничего не удаляет; используйте перед local_ydb_cleanup_storage, чтобы определить точные пути или тома для удаления.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_storage_placementтолько чтениеидемпотентныйвнешний мир

Инспекция хранилища только для чтения, которая возвращает вывод ReadStoragePool и физическое размещение BSC. Используйте перед добавлением или сокращением групп хранения, чтобы подтвердить точную форму пула.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_tenant_checkтолько чтениеидемпотентныйвнешний мир

Проверка только на чтение, использующая YDB CLI для подтверждения доступности настроенного пути к тенанту. Используйте после начальной загрузки (bootstrap) или восстановления, чтобы подтвердить метаданные тенанта перед проверками узлов (node) или GraphShard.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.

local_ydb_upgrade_versionвнешний мир

Обновляет файловый или томовый профиль local-ydb до целевого тега образа. Используется только для обновления версий на профилях без bindMountPath; перед дампом или уничтожением проверяет каждый одноразовый динамический узел и сохраняет его точные gRPC, мониторинг и IC порты, прерываясь при неполном определении. Затем выполняет предварительную проверку исходного и целевого образов, дамп, пересборку, восстановление, повторное применение аутентификации (если настроена), пересоздание дополнительных узлов и финальную верификацию образа. Подтверждённое несоответствие оставляет профиль без изменений; если после успешных этапов пересборки финальный инвентарь недоступен, ответ сохраняет историю команд, сообщает о частичной верификации и сохраняет целевой образ профиля.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to execute the version upgrade plan. Omit or false for plan-only output.
dumpNamestring
Optional dump directory name under profile.dumpHostPath for the upgrade backup.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
versionstringобязательный
Target image tag returned by local_ydb_list_versions.

local_ydb_write_dynamic_auth_configвнешний мир

Записывает файл токена аутентификации text-proto dynamic-node, необходимый для запуска mandatory-auth. Используется после выбора SID для усиления аутентификации; без confirm=true возвращает только запланированную запись файла.

Параметры

configPathstring
Absolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
confirmboolean
Must be true to write the dynamic-node auth token file. Omit or false for plan-only output.
profilestring
Named profile from local-ydb.config.json. Defaults to config.defaultProfile.
sidstring
SID to store in both StaffApiUserToken and NodeRegistrationToken.
tokenHostPathstring
Host path for the generated text-proto auth token file. Defaults to profile.dynamicNodeAuthTokenFile when present.

Github Сайт сервера

Конфиг для установки сервера

{
  "command": "npx",
  "args": [
    "-y",
    "--prefer-online",
    "@astandrik/local-ydb-mcp@latest"
  ],
  "env": {
    "LOCAL_YDB_TOOLKIT_CONFIG": "/path/to/local-ydb.config.json",
    "LOCAL_YDB_MCP_CONTENT_FORMAT": "toon"
  }
}

Нужен npx

Сервер запускается через npx
Без него ничего работать не будет.

Как установить npx

Информация о сервере

Номер в рейтинге: #198
Звезд на Github: 4
Форков на Github: 0
Загрузок: 9 012
Язык реализации: TypeScript
Лицензия: MIT
Официальный сервер: Нет
Дата обновления данных: 08.09 в 23:29
Идентификатор: 3X57j-0NSWQhF0K-
Категории: CI/CD и DevOps, Автоматизация приложений, Базы данных, Инструменты для разработчиков, Облачные платформы