Skip to main content
Glama
Sign In
aapanel-mcp

aapanel-mcp

by devochkaskustikom
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Back up a database

db_backup

Start a database backup for a given database ID and save the resulting file to the panel backup directory.

Instructions

Start a database backup. The result lands in the panel backup directory.

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": {
      "id": "<id>"
    },
    "name": "db_backup"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDatabase id from db_list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1-alpha.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true. The description adds genuinely useful context beyond those flags: the backup artifact's destination directory. It still omits whether the operation is asynchronous, how long it takes, or how to verify completion.

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?

Two short, front-loaded sentences with no filler; the action leads and the destination follows. It is efficient, though the second sentence could have been spent on more consequential information such as async behavior.

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

Completeness3/5

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

For a non-idempotent mutation with no output schema, the description covers the action and the artifact location but leaves the lifecycle unexplained: no indication of whether the call blocks, how to poll status, or that db_backups lists the results. Adequate but with clear gaps.

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%, so the single required 'id' parameter and its 'Database id from db_list.' guidance are fully documented in the schema. The description adds nothing about the parameter, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start a database backup') and adds where the output goes, which distinguishes it from sibling read tools like db_backups. It does not, however, explicitly contrast itself with db_backups or db_restore.

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?

There is no statement of when to use this tool versus alternatives, no prerequisites, and no mention of the closely related db_backups (list) or db_restore siblings. The agent must infer the trigger condition entirely.

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