Skip to main content
Glama

backup.create

Record a new pending backup for an environment. POST .../environments/{env}/backups. idempotency_key uniquely identifies this backup; retrying with the same key is safe.

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": {
      "organization_id": "<organization_id>",
      "project_id": "<project_id>",
      "environment_id": "<environment_id>",
      "idempotency_key": "<idempotency_key>",
      "confirm": "<confirm>"
    },
    "name": "backup.create"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmYesMust be true to apply this mutation; otherwise the tool returns the request it would send for approval.
project_idYesproject_id (required)
environment_idYesenvironment_id (required)
idempotency_keyYesidempotency_key (required)
organization_idYesorganization_id (required)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly=false, destructive=false and idempotent=false, so the description's added value is the pending-state semantics ('record a new pending backup') and the conditional retry safety via idempotency_key. This goes beyond the structured fields, though the claim that 'retrying with the same key is safe' sits in mild tension with idempotentHint=false, and the description never says whether the backup actually runs now or is merely queued for later execution.

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?

Three short sentences, front-loaded with the action, then the endpoint, then the idempotency caveat. Nothing is wasted, though the raw endpoint path is somewhat redundant for an agent that already has the schema.

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

Completeness4/5

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

For a small mutation tool with five required identifiers, no nested objects and no output schema, the definition covers what the call does and how safe retries work. It falls short only on lifecycle follow-up — nothing tells the agent how to confirm the pending backup was created or when it will run.

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%, but the schema descriptions are placeholders ('project_id (required)'), so the baseline applies. The description does add real meaning for one of five parameters by explaining that idempotency_key uniquely identifies the backup and makes retries safe — information the schema does not convey. The remaining identifiers and the confirm gate are left entirely to the schema.

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 and resource ('Record a new pending backup for an environment') plus the underlying endpoint, and the word 'pending' distinguishes it from backup.get, backup.list and backup.restore. An agent can tell immediately that this creates a backup record rather than retrieving or applying one.

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?

Usage is implied by 'record a new pending backup' and reinforced by the endpoint, but there is no explicit statement of when to prefer this over siblings such as backup.restore or backup.list, nor any prerequisites (permissions, environment state). The only genuine guidance is the retry note about idempotency_key.

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