Skip to main content
Glama

pool_scrub_start

Destructive

Start a non-destructive ZFS scrub on a TrueNAS pool to verify data integrity. Use dry_run=True to preview the action before running it.

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

NameRequiredDescriptionDefault
targetNo
dry_runNo
pool_nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.9.0
    • addedInput schema / properties / dry_run
      Added value: +{
      +  "default": false,
      +  "title": "Dry Run",
      +  "type": "boolean"
      +}
  2. First observedv0.1.0

TDQS

A3.9/5.0
Behavior1/5

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

The description states "Non-destructive," while the annotations declare destructiveHint=true — a direct conflict on the same axis. It does add useful behavior (dry-run preview, no undo descriptor, don't re-issue, poll via scrub_status), but the flat contradiction with the structured safety hint is precisely what triggers a score of 1 and the Annotation Contradiction flag.

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?

Front-loaded with the [WRITE] tag and the one-line purpose, followed by short, high-signal sentences on preview, undo, and polling. The undo-descriptor aside is slightly meta but carries real information about the surrounding undo_list/undo_apply ecosystem, so little is wasted.

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?

With 0% schema coverage, no output schema, and a mutating operation, the description covers purpose, preview, idempotency guidance, and progress tracking. It omits anything about the result shape, required privileges, or how long a scrub takes, but the essentials for calling it correctly are present.

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?

Schema description coverage is 0%, so the description must carry the load, and it does: pool_name is explained with an example ('tank'), dry_run's preview semantics are stated, and target is identified as a TrueNAS target name from config. No types, defaults, or value constraints beyond the schema are added, which keeps it just short of a 5.

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?

Specific verb + resource: "Start a scrub (integrity check) on a pool," with the mode tagged as [WRITE]. The parenthetical gloss clarifies what a scrub is, and the sibling scrub_status is named as the progress-polling counterpart, so an agent can distinguish the two without opening either schema.

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?

Explicit routing: "Pass dry_run=True to preview" and "Poll progress with scrub_status; do not re-issue." It states both the preview path and the alternative tool for progress, which is exactly the when-to-use/when-to-use-something-else guidance the dimension asks for.

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