Skip to main content
Glama
szoran53
by szoran53

Set ZFS Property

zfs_set_property
Idempotent

Set ZFS dataset properties such as compression, recordsize, or atime to adjust storage behavior. Requires sudo.

Instructions

Set a property on a ZFS dataset (sudo).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDataset name
valueYesProperty value (e.g. lz4, 1M, off)
propertyYesProperty name (e.g. compression, recordsize, atime)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, so the mutation/idempotency profile is covered. The description adds the meaningful detail that the operation requires sudo, but says nothing about what happens on invalid property names or whether changes take effect immediately.

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?

A single short sentence that front-loads the action and resource with no filler. It is efficient, though the parenthetical sudo note is the only extra content and more could have been said without bloat.

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

Completeness3/5

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

For a mutation tool with full schema coverage and annotations covering safety and idempotency, the essentials are present, and the sudo requirement is flagged. However, with no output schema and no error/permission behavior described, an agent lacks enough information about failure modes to be fully prepared.

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 coverage is 100%, with each of name/value/property already documented and exemplified in the schema (lz4, 1M, off; compression, recordsize, atime). The description adds no further parameter detail, so the baseline of 3 applies.

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 specific verb (Set) and resource (a property on a ZFS dataset), which lets an agent distinguish it from zfs_get_property and, via the word 'dataset', from zfs_pool_set_property. It does not explicitly name those siblings, so it falls short of a 5.

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?

There is no guidance on when to use this tool versus zfs_pool_set_property or zfs_get_property, nor any prerequisites beyond the parenthetical '(sudo)'. The agent must infer usage from context alone.

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