Skip to main content
Glama

xo_run_backup

Trigger an immediate backup job by job ID for a target gateway, with the write action recorded in the audit log.

Instructions

Trigger a backup job immediately.

Write operation — recorded in the audit log.

Args: job_id: Backup job ID (from xo_list_backups). gateway_id: Target gateway (optional).

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": {
      "job_id": "<job_id>"
    },
    "name": "xo_run_backup"
  }
}

Input Schema

NameRequiredDescriptionDefault
job_idYes
gateway_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.72.5

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden; it does disclose that this is a write operation and that it is recorded in the audit log, which is genuinely useful context. However, it omits key behavioral traits for a mutation: whether the call returns immediately or blocks until completion, whether it returns a task handle, and whether repeated calls are idempotent or spawn duplicate jobs.

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 action statement is front-loaded and wastes no words, and the Args block is short. The parenthetical 'optional' on gateway_id duplicates schema information, a minor redundancy.

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 two-parameter mutation with no output schema and no annotations, the definition covers purpose and audit logging but leaves the agent unsure what a successful call returns and whether to wait or poll (likely via xo_list_tasks). That gap matters for correct invocation.

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 0%, so the description must add meaning, and it does partially: job_id is tied to xo_list_backups as its provenance. The gateway_id entry ('Target gateway (optional)') restates the schema's optionality and null default without explaining what choosing a gateway changes, so half the parameters remain semantically thin.

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?

The opening line gives a specific verb and resource ('Trigger a backup job immediately'), which is unambiguous and distinguishes it from listing siblings such as xo_list_backups and from xo_restore_backup. It stops short of explicitly naming a contrasting sibling, but the action is clear enough to select on.

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 definition implies usage by pointing at xo_list_backups as the source of a valid job_id, which is a useful entry point. It does not state when to prefer this over alternatives (e.g., scheduled backups vs. restores) or any preconditions such as the job needing to exist or be idle.

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