Skip to main content
Glama

update_snapshot_description

Updates the description of an existing 1Panel snapshot by ID, letting you label or document backups for easier identification.

Instructions

Update snapshot description

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.5/5.0
Behavior1/5

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

No annotations are provided, so the description carries the full behavioral burden, yet it discloses nothing: no permission requirements, no indication of whether the change is reversible, no note on what happens to an existing description, and no error behavior. This is a mutation tool with zero behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is short and front-loaded, but its brevity stems from under-specification rather than efficiency. A single phrase that merely echoes the tool name earns no credit for conciseness.

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

Completeness1/5

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

For a two-required-parameter mutation tool with no annotations, no output schema, and no documented parameters, the description is wholly inadequate. An agent cannot determine which snapshot to target, what value to supply, or what the effect will be.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% — neither 'id' nor 'description' has any documentation in the schema. The description does not compensate at all: it never states what 'id' identifies (which snapshot?) or clarifies that 'description' is the new value being written rather than a filter.

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

Purpose2/5

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

The description 'Update snapshot description' is a verbatim restatement of the tool name, adding no distinguishing information beyond what the name already conveys. It does identify the verb (update) and resource (snapshot description), but that is a tautology rather than a description.

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 guidance on when to use this tool versus siblings such as create_snapshot, delete_snapshot, or recreate_snapshot. No prerequisites, no exclusions, no context about when a snapshot description edit is appropriate.

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