Skip to main content
Glama
Sign In
TrueNAS Core MCP Server

TrueNAS Core MCP Server

by vespo92
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

create_snapshot

Create a snapshot of a dataset on TrueNAS Core, specifying the dataset path, snapshot name, and optional recursion for nested datasets.

Instructions

Create a snapshot of a dataset

Args:
    dataset: Dataset path (e.g., "tank/data")
    name: Snapshot name
    recursive: Whether to create recursive 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": {
      "dataset": "<dataset>",
      "name": "<name>"
    },
    "name": "create_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
datasetYes
nameYes
recursiveNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. While 'Create' implies a write operation, it doesn't mention whether this requires specific permissions, whether snapshots are immutable, what happens if a snapshot with the same name exists, or any rate limits. The description lacks essential behavioral context for a mutation tool.

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 description is appropriately sized with a clear purpose statement followed by parameter explanations. The 'Args' section is well-structured. However, the first sentence could be more front-loaded with additional context about snapshot behavior or usage scenarios.

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?

For a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what a snapshot actually is in this context, what the tool returns, whether the operation is synchronous, or error conditions. The agent lacks crucial information to use this tool effectively.

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

Parameters4/5

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

The description provides parameter semantics in the 'Args' section, explaining what each parameter represents. With 0% schema description coverage, this compensates well by documenting all three parameters. However, it doesn't elaborate on format constraints (e.g., valid snapshot name patterns) or the implications of the recursive option.

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 clearly states the verb ('Create') and resource ('snapshot of a dataset'), making the purpose immediately understandable. It distinguishes from siblings like 'create_dataset' by specifying the snapshot operation rather than dataset creation. However, it doesn't explicitly differentiate from 'create_snapshot_policy' which might be a closer sibling.

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 provides no guidance on when to use this tool versus alternatives. There's no mention of prerequisites, when snapshots are appropriate, or how this differs from other snapshot-related tools like 'create_snapshot_policy'. The agent must infer usage from the tool name alone.

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

Related Tools