Skip to main content
Glama

backup user

backup_user

Start a complete backup for a HestiaCP user account, preserving data and settings.

Instructions

Start a complete user backup. Executes verified command v-backup-user.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
userYes
notifyNono

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
dataNo
errorNo
commandYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already indicate the operation is not read-only whether it is idempotent, and that it is not destructive. The description adds that it executes the verified command 'v-backup-user', which gives some implementation context, but it does not disclose potential side effects, duration, or async behavior.

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 two short sentences with no fluff or repetition. The core action is front-loaded, and the implementation detail is brief and relevant.

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 simple action, the core intent is clear)Skip but the description leaves gaps around when to use it, what the 'notify' parameter actually controls, and what consequence 'starting' a backup has. The output schema likely covers return values, but the explanation of preconditions and side effects is thin.

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%, so the description should compensate for undocumented parameters. It does not explain the purpose of 'user' or the semantics of the 'notify' option. The schema provides type and constraints, but the description adds no parameter-level meaning.

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 states a specific verb ('Start') and resource ('complete user backup'), making the tool's function immediately clear. It is naturally distinguished from the sibling list_user_backups, since one creates a backup and the other lists them.

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

Usage Guidelines3/5

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

The description implies the appropriate use case – initiating a user backup – but provides no explicit when/when-not guidance or mention of alternatives. An agent can infer the purpose, but the description does not actively aid in choosing between this and related tools.

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