Skip to main content
Glama

database_dump

database_dump

Export the project's platform-provisioned database: starts a cluster-side dump Job in your own tenant namespace (mariadb-dump --single-transaction, zstd-compressed; gzip fallback) writing a compressed artifact to your tenant artifact store. Small dumps finish inline and return metadata + a presigned download URL (expires in ~24 h; the artifact itself is purged after 7 days). Large dumps return a dump_id with status=running — poll dump_status. The dump bytes NEVER pass through this tool response. Rate limit: 2 per hour per account.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>"
    },
    "name": "database_dump"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

With only readOnlyHint=false from annotations, the description carries substantial behavioral detail: cluster-side job execution, tenant namespace, dump command and compression, artifact storage, presigned URL expiry, 7-day purge, response exclusion of dump bytes, and a rate limit. These are exactly the operational facts an agent needs before invoking a job-producing tool.

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?

The description is front-loaded with the core action, then adds size-dependent behavior, artifact lifecycle, response constraint, and rate limit in four dense sentences. Every sentence contributes operational value without repetition.

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

Completeness5/5

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

There is no output schema, but the description fully covers return behavior for both small and large dumps, URL expiry, and artifact purge. It also explains the polling path and rate limit, leaving no major operational gap for an agent calling the tool.

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

Parameters2/5

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

Schema description coverage is 0%, and the single parameter 'project' is not documented in the description beyond being the target of the dump. The description does not clarify whether it is a project ID, name, or slug, so an agent must infer the format from context.

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 ('Export') and resource ('the project's platform-provisioned database') and clearly distinguishes the action from the polling sibling dump_status. The description leaves no ambiguity about what the tool produces.

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?

Explains that small dumps return inline while large dumps return a dump_id that must be polled via dump_status, which is explicit routing guidance. It does not state when-not to use the tool or name other alternatives, but the primary usage context is clear.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources