Skip to main content
Glama

dokploy_database

Manage databases across Postgres, MySQL, MariaDB, MongoDB, Redis, and libSQL with full lifecycle actions: create, deploy, update, move, and environment configuration.

Instructions

Manage databases (postgres/mysql/mariadb/mongo/redis/libsql). create: dbType+name+environmentId+databasePassword. Per-engine extras — postgres/mysql/mariadb: REQUIRE databaseName+databaseUser; mysql/mariadb also accept databaseRootPassword. mongo: REQUIRES databaseUser (databaseName not used). redis: only databasePassword (no databaseName/User). libsql: REQUIRES appName+dockerImage+sqldNode (primary|replica); accepts sqldPrimaryUrl+enableNamespaces. get: dbType+databaseId (returns metadata + masked env summary — never values). update: dbType+databaseId+fields. move: dbType+databaseId+targetEnvironmentId. start/stop/deploy/rebuild/remove: dbType+databaseId. reload: dbType+databaseId+appName. changeStatus: dbType+databaseId+applicationStatus (idle|running|done|error). saveEnvironment: dbType+databaseId+env (full replace). setEnvVars: dbType+databaseId + set?/unset? (merge inside the server, masked confirmation only). getEnvKeys: dbType+databaseId — KEY names only. getEnvValuesUnsafe: dbType+databaseId — UNSAFE escape hatch that returns full KEY=VALUE pairs. saveExternalPort: dbType+databaseId+externalPort (libsql also accepts externalGRPCPort/externalAdminPort). search: dbType + q|name|appName|description|projectId|environmentId + limit/offset — searches within the given dbType (not supported for libsql).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNosearch: freeform query
envNoEnvironment variables as KEY=VALUE pairs, one per line. Used by saveEnvironment (full replace).
setNosetEnvVars: KEY=VALUE pairs to upsert, one per line.
nameNo
limitNosearch: max results (default 20)
unsetNosetEnvVars: list of KEY names to remove.
actionYes
dbTypeYespostgres, mysql, mariadb, mongo, redis, or libsql
offsetNosearch: pagination offset
appNameNo
commandNo
cpuLimitNo
serverIdNo
sqldNodeNolibsql sqld role
projectIdNosearch: filter to a project
databaseIdNo
descriptionNo
dockerImageNo
memoryLimitNo
databaseNameNo
databaseUserNo
externalPortNo
environmentIdNo
sqldPrimaryUrlNolibsql replica primary URL
databasePasswordNo
enableNamespacesNolibsql multi-tenant namespaces
externalGRPCPortNolibsql only
applicationStatusNo
externalAdminPortNolibsql only
targetEnvironmentIdNo
databaseRootPasswordNomysql/mariadb only
Behavior5/5

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

No annotations are provided, so the description carries the full burden. It discloses return behavior ('get: ... masked env summary — never values'), state change semantics ('saveEnvironment: env (full replace)'), and safety ('getEnvValuesUnsafe: UNSAFE escape hatch'). It also notes limitations like 'search ... not supported for libsql'.

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?

Although long, the description is dense and efficiently organized by action with colons and semicolons. Every sentence carries operational detail, and there is no redundant or promotional language.

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?

The description is largely complete for a tool with 31 params and 17 actions: it groups parameters by action and engine and explains return and unsafe behaviors. However, a few schema parameters (cpuLimit, memoryLimit, serverId, command) are not explained anywhere, leaving gaps for update/create scenarios. Given the absence of an output schema and annotations, these omissions prevent a perfect score.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 45%, but the description compensates by explaining which parameters are required per action/engine (e.g., 'postgres/mysql/mariadb: REQUIRE databaseName+databaseUser', 'mongo: REQUIRES databaseUser (databaseName not used)') and clarifies the meaning of fields like set/unset for setEnvVars and q/limit/offset for search.

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 opens with 'Manage databases (postgres/mysql/mariadb/mongo/redis/libsql)', specifying the verb and resource. The 17 enumerated actions (create, get, update, move, start, stop, etc.) clarify the scope and distinguish it from sibling resource management tools like dokploy_application or dokploy_compose.

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?

The description provides clear context for when to use the tool (any database management operation) and breaks down per-action and per-engine requirements. However, it does not explicitly discuss alternatives or when not to use this tool (e.g., when managing applications or deployments), so it stops short of full exclusion 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/sapientsai/dokploy-mcp-server'

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