Skip to main content
Glama

snapshot_create

Destructive

Create a ZFS snapshot for a dataset to capture its current state. Preview with dry_run=True before creating.

Instructions

[WRITE] Create a ZFS snapshot 'dataset@name'. Inverse: snapshot_delete. Pass dry_run=True to preview.

Args: dataset: Dataset path to snapshot (e.g. 'tank/data'). name: Snapshot name (e.g. 'manual-2026-06-28'). dry_run: If True, preview without creating (and without an undo token). target: TrueNAS target name from config.

Input Schema

NameRequiredDescriptionDefault
nameYes
targetNo
datasetYes
dry_runNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.9.0
    • addedInput schema / properties / dry_run
      Added value: +{
      +  "default": false,
      +  "title": "Dry Run",
      +  "type": "boolean"
      +}
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false, so the safety profile is covered. The description adds genuine context beyond that: the [WRITE] tag, that dry_run previews without creating, and notably that a preview also omits the undo token — implying real creates are undoable via the undo_list/undo_apply siblings.

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?

Front-loaded with the [WRITE] marker and inverse reference, and the Args block is justified given zero schema coverage. Slightly formulaic listing, but no sentence is wasted and the essential information comes first.

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?

A mutation tool with no output schema and annotations covering the destructive profile; the description covers semantics, preview behavior, and undo-token implications. It omits failure behavior — e.g. what happens if the snapshot already exists, which matters given idempotentHint=false.

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

Parameters5/5

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

Schema description coverage is 0%, so the description carries the full parameter burden and does so: dataset with a path example ('tank/data'), name with a naming example, dry_run with its preview and undo-token implication, and target as a TrueNAS target name from config. All four params gain meaning the schema lacks.

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?

States a specific verb and resource ('Create a ZFS snapshot'), gives the exact naming form 'dataset@name', and names the inverse sibling snapshot_delete. An agent can distinguish it from snapshot_list and snapshot_delete without opening a schema.

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?

Clearly frames this as the write path with snapshot_delete as its inverse, and describes the dry_run preview option. It stops short of stating explicit exclusions (e.g. when to prefer snapshot_list first, or behavior when the snapshot already exists).

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