Skip to main content
Glama

snapshot_list

List ZFS snapshots from TrueNAS, optionally filter by dataset, and adjust limit to retrieve full sets if results are truncated.

Instructions

[READ] List ZFS snapshots, optionally filtered to one dataset.

Returns {"snapshots": [...], "returned": N, "limit": L, "truncated": bool}. When "truncated" is true there are more snapshots than were returned — re-run with a higher limit or filter to one dataset.

Args: dataset: Optional dataset path to filter (e.g. 'tank/data'). limit: Max snapshot rows to return (default 200). target: TrueNAS target name from config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
targetNo
datasetNo
Behavior4/5

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

With no annotations, the description carries full responsibility. It explicitly marks the operation as [READ], discloses the return structure including the 'truncated' flag, and explains what to do if truncation occurs. This goes beyond a simple 'list' by informing the agent about safety and pagination-like behavior.

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 well-structured and concise: a one-line summary, then a return format explanation, then an organized Args block. Every sentence adds value, and there is no fluff or repetition.

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

Completeness5/5

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

Given there is no output schema and no annotations, the description completely covers what the tool returns, how to interpret truncation, and what each parameter does. It even advises on next steps for a common edge case, making it fully sufficient for an agent to select and invoke the tool.

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?

The schema provides no parameter descriptions (0% coverage), but the description's Args section explains each parameter clearly: dataset with an example, limit with its default, and target as a config-based name. This fully compensates for the schema's silence.

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 clearly states 'List ZFS snapshots, optionally filtered to one dataset' with a specific verb and resource. It distinguishes this from sibling tools like snapshot_create and snapshot_delete by being a read-only listing operation.

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?

It provides clear context on when to use the tool (to list snapshots) and offers practical guidance on handling truncation by increasing the limit or filtering to one dataset. However, it does not explicitly mention when not to use it or name alternative tools for other operations.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AIops-tools/TrueNAS-AIops'

If you have feedback or need assistance with the MCP directory API, please join our Discord server