Skip to main content
Glama

pool_scrub_start

Initiate a non-destructive integrity check (scrub) on a ZFS pool to detect and repair data inconsistencies. Progress is tracked via a separate status call.

Instructions

[WRITE] Start a scrub (integrity check) on a pool. Non-destructive.

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'). target: TrueNAS target name from config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNo
pool_nameYes
Behavior3/5

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

With no annotations, the description covers key behaviors: it is a write operation ([WRITE]), non-destructive, and has no undo. It implies an asynchronous invocation by directing to poll scrub_status. However, it omits potential performance impacts and permission requirements.

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 well-structured. The [WRITE] tag is front-loaded for quick identification. Each sentence adds value without redundancy. The use of bullet points for parameters is clear.

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

Completeness4/5

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

Given the absence of an output schema, the description adequately covers the invocation and follow-up (poll scrub_status). It lacks details on the immediate return value (e.g., whether it returns a status or job ID) but is otherwise sufficient for the tool's complexity.

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 adds meaning to both parameters beyond the bare schema (which has no descriptions). It explains pool_name with an example and target as coming from config. It could be more precise on the default behavior of target when not provided.

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 the verb 'Start' and resource 'scrub (integrity check) on a pool'. It also distinguishes the tool from its sibling 'scrub_status' which is for polling progress.

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?

The description advises to poll scrub_status for progress and explicitly says 'do not re-issue', which is useful guidance. It does not, however, mention when not to start a scrub (e.g., if one is already running), though the implicit advice is to check first.

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