scrub_status

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

No annotations provided; description only says it's a read operation and returns three fields. Fails to disclose error handling (e.g., missing pool_id), auth requirements, or performance implications.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences: one-line summary with '[READ]' tag, then args list. Front-loaded, zero filler.

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

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

No output schema; mentions return fields but not full structure or possible errors. Adequate for a simple read tool but lacks detail on edge cases.

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

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

Schema coverage 0%, but description adds domain meaning: 'pool_id: TrueNAS pool id' and 'target: TrueNAS target name from config'. Clarifies purpose of each parameter beyond just type.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states it reads scrub scan state for a pool, mentioning specific fields (function/state/percentage). It distinguishes from write sibling 'pool_scrub_start'.

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

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

No explicit guidance on when to use vs alternatives (e.g., pool_scrub_start). Usage is implied but not stated.

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