Skip to main content
Glama

Dump database (SSH mysqldump)

database_dump

Export a MySQL database to a local .sql file using SSH and mysqldump. Requires SSH host alias and database credentials.

Instructions

Export a MySQL database to a local .sql file via SSH + mysqldump. Requires an SSH host alias (KAS_SSH_HOST) that lands on the KAS shell.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gzipNoGzip the dump (default false)
db_nameYesDatabase name to dump, e.g. d00xxxxx
db_userYesMySQL user (usually same as db name on all-inkl)
ssh_hostNoOverride the ~/.ssh/config alias (defaults to KAS_SSH_HOST)
db_passwordYesMySQL password
Behavior2/5

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

No annotations are provided, so the description carries full burden. It does not disclose important behaviors such as whether the .sql file is created on the local machine or the remote server, what happens on failure, whether existing files are overwritten, or any security implications beyond the SSH alias.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short (two sentences) and front-loaded with the core purpose. It wastes no words, but could be more informative without sacrificing conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 5-parameter tool with no output schema and no annotations, the description is insufficient. It fails to explain the output location/name, return values, error handling, or required permissions beyond the SSH alias. The dump operation is complex and needs more context.

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 coverage is 100%, so the baseline is 3. The description adds context about the SSH host default and typical db_user convention ('usually same as db name on all-inkl'), but doesn't provide additional format or constraint details beyond what the schema already describes.

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 clearly states 'Export a MySQL database to a local .sql file via SSH + mysqldump.' This is a specific verb (export) and resource (MySQL database) that distinguishes it from sibling tools like database_add, database_delete, and database_list.

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

Usage Guidelines2/5

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

The description mentions a prerequisite ('Requires an SSH host alias (KAS_SSH_HOST)') but gives no guidance on when to use this tool vs alternatives (e.g., database_list or cronjob for scheduled dumps). There is no explicit when-not-to-use or comparison with siblings.

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/art-design-digital/allinkl-mcp'

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