Skip to main content
Glama

pool_scrub_start

Start a non-destructive scrub on a ZFS pool to check data integrity and repair corruption. Preview actions with dry_run before executing.

Instructions

[WRITE] Start a scrub (integrity check) on a pool. Non-destructive. Pass dry_run=True to preview.

No undo descriptor (a scrub has no clean inverse beyond cancellation). Poll progress with scrub_status; do not re-issue.

Args: pool_name: ZFS pool name (e.g. 'tank'). dry_run: If True, preview without starting the scrub. target: TrueNAS target name from config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNo
dry_runNo
pool_nameYes
Behavior5/5

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

With no annotations provided, the description carries the full burden. It declares '[WRITE]' and 'Non-destructive,' notes the absence of an undo descriptor, and implies asynchronous behavior via 'Poll progress.' This is transparent and honest about side effects.

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 concise and front-loaded: purpose first, then behavioral notes, then args. Every sentence adds value with no wasted words or repetition of schema defaults.

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?

Despite no output schema, the description covers the operation's outcome, next steps (scrub_status), and all parameter details. It also mentions the non-reversible nature, making it complete for the tool's complexity.

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?

Schema description coverage is 0%, so the inline Args section is essential. It fully explains each parameter: pool_name format with example, dry_run semantics, and target's role. This compensates completely for the schema's lack of descriptions.

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 'Start a scrub (integrity check) on a pool,' identifying the specific action and resource. It distinguishes the tool from siblings like scrub_status (monitoring) and pool_list/pool_get (listing).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly instructs to 'Poll progress with scrub_status; do not re-issue,' providing both an alternative and a when-not. It also mentions dry_run preview, giving clear usage context.

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