SuperAPI AI Directory

local-ydb-toolkit

Operate Docker-based local-ydb deployments locally or over SSH: bootstrap, diagnostics, auth hardening, storage workflows, dump/restore and upgrades.

Open website

About this tool

Purpose: For agents that need to operate a Docker-based local-ydb environment, providing capabilities such as host preflight checks, root database or tenant bootstrap, dynamic node lifecycle, GraphShard checks, table DDL generation/validation/application, authentication hardening, storage workflows, dump/restore, and version upgrades. Complementary to the official ydb/ydb-mcp: the latter is for general database-level tools (ad-hoc SQL, query explanation, directory and path inspection), while this toolkit is for operating the local-ydb environment itself.

Main capabilities: The repository contains reusable Codex skills, an unofficial local stdio MCP server published as @astandrik/local-ydb-mcp (exposing 39 tools), and the GitHub Actions action astandrik/setup-local-ydb for starting a one-off YDB tenant in CI. Read-only tools can collect inventory, tenant status, health checks, schema objects, DDL, permissions, node and GraphShard status, authentication posture, storage placement, image tags, and more. Mutating tools generate only a plan by default and require confirm: true to execute.

Usage: The MCP launcher requires Node.js 20.19 or higher and npx. You can install the skill via Codex, or use the npm package to connect directly to an MCP client, or install it globally. Profile-based invocation requires an absolute configPath, or set LOCAL_YDB_TOOLKIT_CONFIG to an absolute path; the explicit path must point to a readable regular JSON file of no more than 1 MiB, and missing or invalid values will fail closed. For a configuration example, see examples/local-ydb.config.example.json. Profiles support mode: "local" or mode: "ssh" (executed via ssh -o BatchMode=yes -o ConnectTimeout=10). Tenant profiles can set dynamicNodeCount (default 1, range 1..11).

Applicable scenarios and limitations: Suitable for local-ydb operations on a local Docker host or over remote SSH, temporary tenant testing in CI, authentication hardening, and storage maintenance. SSH uses the existing SSH agent/key/known_hosts and does not store SSH passwords. Under Linux Docker Engine, SDK-type tools can access Docker's internal gRPC ports via an SSH tunnel; the Docker Desktop and rootless Docker fallback paths are not supported. The public OpenAI submission contains only the skill, because public MCP submissions require a production HTTPS MCP server. The Claude community submission and Gemini extension gallery inclusion status are subject to the official directories.