Skip to main content
Glama

local_ydb_prepare_auth_config

Generates a hardened YDB auth config from the current static-node config and returns a write plan unless confirmed, to prepare before applying dynamic auth and hardening.

Instructions

Generate a hardened YDB config from the current static-node config. Use before local_ydb_write_dynamic_auth_config and local_ydb_apply_auth_hardening; without confirm=true this returns the planned write only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sidNoSID to place into viewer, monitoring, administration, and register_dynamic_node_allowed_sids. Defaults to profile.dynamicNodeAuthSid or root@builtin.
confirmNoMust be true to write the hardened config file. Omit or false for plan-only output.
profileNoNamed profile from local-ydb.config.json. Defaults to config.defaultProfile.
configPathNoAbsolute path to an explicit local-ydb config file. Missing, unreadable, oversized, or invalid explicit files fail closed instead of using defaults.
configHostPathNoHost path for the generated hardened config. Defaults to profile.authConfigPath when present.

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. Addedv0.1.5
  5. Removedv0.1.4
  6. 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."
    • 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 write the hardened config file. 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."
  7. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations only mark the tool as non-read-only and non-destructive; the description adds that without confirm=true it returns the planned write rather than performing it. This discloses the side-effect boundary, though it does not detail the plan's structure or failure modes beyond schema notes.

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 concise sentences front-load purpose then usage. Every phrase contributes, with no filler.

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 no output schema, the description covers the core invocation contract (plan vs. write) and workflow placement. It relies on the schema for parameter depth, and although the return plan format is unspecified, this is acceptable when the plan is for human review.

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?

All five parameters are fully described in the input schema, so the baseline is a neutral 3. The description's only mention, confirm=true, restates what the schema already says, adding no new per-parameter meaning.

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 uses a specific verb ('Generate') and resource ('hardened YDB config from the current static-node config'), making the action unambiguous. It also names the sibling tools it precedes, distinguishing it from local_ydb_write_dynamic_auth_config and local_ydb_apply_auth_hardening.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs to 'Use before local_ydb_write_dynamic_auth_config and local_ydb_apply_auth_hardening', establishing a clear workflow position. It also explains the confirm flag semantics, telling the agent that omitting confirm=true yields a plan-only run.

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