Skip to main content
Glama

sylve_jail_snapshot

Destructive

List, create, roll back, or delete ZFS snapshots for FreeBSD jails to manage recovery points and revert changes.

Instructions

List, create, roll back, or delete Jail ZFS snapshots.

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": {
      "action": "<action>",
      "jail": "<jail>"
    },
    "name": "sylve_jail_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
jailYesJail CTID or name.
nameNoSnapshot name (create).
nodeNoTarget cluster node hostname or UUID. Omit for cluster-wide.
actionYes
contextNoNamed login context from ~/.config/sylve/config.yaml.
descriptionNo
snapshot_idNoSnapshot ID (rollback/delete).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/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 known. The description merely enumerates actions and adds no behavioral context such as irreversibility of rollback/delete, required permissions, or effects on the jail.

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?

The definition is a single front-loaded sentence with no filler. It is appropriately concise, though the terseness contributes to gaps in other dimensions rather than being a flaw of structure.

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

Completeness2/5

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

This is a destructive multi-action tool with seven parameters and no output schema. A one-sentence description leaves important context unexplained: action-specific behavior, return values, prerequisites, and the consequences of rollback/delete.

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 71%, so most parameters are documented in the schema. The description contributes no parameter meaning at all; its action list duplicates the action enum, and the undocumented 'description' parameter is not compensated for.

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?

The description states a specific set of verbs (list, create, roll back, delete) and a precise resource (Jail ZFS snapshots). It distinguishes itself from sylve_vm_snapshot by scoping to jails, though it does not explicitly reference the sibling sylve_zfs_snapshot.

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 description lists possible actions but gives no guidance on when to use this tool versus alternatives such as sylve_zfs_snapshot or sylve_vm_snapshot. It also does not explain when each action (list vs create vs rollback vs delete) is appropriate.

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