Skip to main content
Glama
zb-ss

Servonaut

by zb-ss
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

db_setup_save

Commit the DB credential staged by db_setup_scan to the secret store and write a db_profile, enabling db_processlist and db_top_queries. Confirm before saving.

Instructions

Commit a staged DB credential (from db_setup_scan) to the secret store and write a db_profile, making db_processlist / db_top_queries work for the instance. The password is read from server-side staging by token — never from your context. Mutating: confirm with the user first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNoOverride DB host.
portNoOverride DB port.
userNoOverride DB user.
labelNoApp/site label for this DB (e.g. the website), so multiple DBs on one instance don't collide. Defaults to a value derived from the config path the credential came from.
tokenYesStaging token from db_setup_scan.
engineNoOverride engine (mysql|postgres).
databaseNoOverride default database.
instance_idNoInstance to attach the profile to (id or name; stored under its instance id). Defaults to the instance db_setup_scan scanned (not the DB host).
password_secretNoSecret-store key name (default db/<instance>[/<label>]).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.28.0
    • changedInput schema / properties / instance_id / description
      Previous value: -"Instance to attach the profile to."New value: +"Instance to attach the profile to (id or name; stored under its instance id). Defaults to the instance db_setup_scan scanned (not the DB host)."
  2. Addedv2.24.0
  3. Removedv2.23.8
  4. Changed2 schema fields changedv2.23.0
    • addedInput schema / properties / label
      Added value: +{
+  "description": "App/site label for this DB (e.g. the website), so multiple DBs on one instance don't collide. Defaults to a value derived from the config path the credential came from.",
+  "type": "string"
+}
    • changedInput schema / properties / password_secret / description
      Previous value: -"Secret-store key name (default db/<instance>)."New value: +"Secret-store key name (default db/<instance>[/<label>])."
  5. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and does well: it discloses that the operation is mutating, requires user confirmation, writes to two stores (secret store + db_profile), and that the password is read server-side by token and never enters the agent's context. It omits idempotency/repeat-commit behavior and whether an existing profile is overwritten.

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?

Three short sentences, front-loaded with the action and outcome before the safety note. Every clause earns its place; 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 9-parameter, mutating tool with no annotations and no output schema, the description covers purpose, prerequisites, credential-handling security, and the confirmation requirement. Minor gaps remain around failure behavior (e.g., expired token, unreachable DB) and repeat invocations.

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 description coverage is 100% across all 9 parameters, so the baseline is 3. The description reinforces the token's provenance ('Staging token from db_setup_scan') and the side effects of the instance/label defaults, but adds no syntax or format detail the schema does not already carry.

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?

States a specific verb+resource pair ('Commit a staged DB credential ... to the secret store and write a db_profile') and explicitly names the source tool (db_setup_scan) and the downstream consumers (db_processlist / db_top_queries). An agent can distinguish this from db_setup_remove and db_setup_scan without opening any schema.

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

Usage Guidelines4/5

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

Establishes the prerequisite chain clearly: the credential must come from db_setup_scan, and it warns 'Mutating: confirm with the user first.' It does not name db_setup_remove as the inverse/alternative or state when a re-scan is required, so it stops just short of full when/when-not guidance.

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