Skip to main content
Glama

Create a manual snapshot (backup) for a site

create_snapshot
Destructive

Take a point-in-time Longhorn snapshot of a site's served files. It does not change served content, but retention cleanup may remove older backups. Requires an owner or admin team role. Returns NO_VOLUME if the site has no volume yet (it has never been deployed).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
labelNoOptional human-readable label for this backup.
siteIdNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
createdYes
snapshotNameYesThe name of the snapshot that was created.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedOutput schema / properties / request_id
      Removed value: -{
      -  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      -  "type": "string"
      -}
  2. Changed1 schema field changed
    • addedOutput schema / properties / request_id
      Added value: +{
      +  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already signal mutating and destructive behavior, but the description adds valuable specifics: served content is unchanged, retention cleanup may remove older backups, authentication requirements, and a specific error condition. This goes well beyond the structured annotations without contradicting them.

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 compact and front-loaded with the core purpose, then efficiently covers side effects, permissions, and a key error case. Every sentence adds distinct value with no redundancy.

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?

The description covers the operation's behavior, side effects, authorization, and a notable error. However, the lack of parameter semantics and the fact that no parameters are marked required leaves some ambiguity about the minimum valid call. An output schema exists, so return-value documentation is not a gap.

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 only 33%, and the description does not compensate. It never explains what 'name' or 'siteId' mean, which parameters are required, or how they relate to the snapshot operation. Only 'label' is documented in the schema, leaving most parameters under-specified.

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 action ('Take a point-in-time Longhorn snapshot') on a specific resource ('a site's served files'), and explicitly frames it as a manual backup. This clearly distinguishes it from related tools like list_snapshots or deploy_site.

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?

The description provides useful context: it is a manual snapshot, it does not alter served content, it requires an owner/admin role, and it may fail with NO_VOLUME if the site was never deployed. It does not explicitly name alternative tools or when-not-to-use conditions, so it misses the top tier.

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.