Skip to main content
Glama
szoran53
by szoran53

Create ZFS Snapshot

zfs_create_snapshot

Create a ZFS snapshot in dataset@snapname format to capture a point-in-time state for backup, rollback, or cloning.

Instructions

Create a ZFS snapshot (sudo). Use format dataset@snapname.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
snapshotYesSnapshot name in dataset@snapname format

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false and destructiveHint=false, so the safety profile is covered. The description's '(sudo)' adds genuinely new context about required privileges, but says nothing about storage consumption, failure behavior on duplicate names, or what happens on an existing snapshot.

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?

Two short clauses, front-loaded with the action and immediately followed by the format constraint. No filler; every phrase carries information.

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 one-parameter tool with no output schema and annotations covering the safety profile, the description is nearly sufficient. It still omits whether the target dataset must pre-exist and how failures are reported, which an agent would want before invoking it.

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 100% for the single 'snapshot' parameter, and the schema already documents the dataset@snapname format. The description restates the same format rather than adding syntax, validation, or naming rules, so the baseline of 3 is appropriate.

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?

States a precise verb and resource ('Create a ZFS snapshot'), which naturally separates it from zfs_list_snapshots and zfs_destroy_snapshot. It does not, however, explicitly name or contrast with those siblings, so it falls just short of the top band.

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?

The only usage signal is the parenthetical '(sudo)', which implies a privilege requirement but never states when to use this tool versus alternatives. No prerequisites (parent dataset must exist) or exclusion conditions are given.

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