List Scheduled Scrub Tasks

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

Annotations already mark the tool as read-only, so the bar is lower. The description adds valuable context: it clarifies that it lists scheduled tasks (not currently running ones) and enumerates the returned fields. This goes beyond what annotations state, though it doesn't cover potential edge cases like empty results.

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 tight sentences: the first gives the primary purpose and key output details, the second provides a useful distinction from a sibling tool. No wasted words or redundancy.

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?

The tool is simple with one optional parameter and an output schema. The description covers its scope, the relationship to a sibling, and the read-only nature is already in annotations. No significant gaps remain.

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?

The only parameter, response_format, is fully described in the schema with enum, default, and description, achieving 100% schema coverage. The tool description itself does not add additional parameter details, so the baseline of 3 is appropriate.

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?

The description states exactly what it does: 'List scheduled pool scrub tasks' and specifies the attributes returned (pool, schedule, threshold, enabled state). It also differentiates it from truenas_list_pools by noting that the sibling only shows a scrub while running.

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?

The description explicitly mentions the sibling tool truenas_list_pools and its behavior, implying this tool is for viewing scheduled scrub configurations rather than active scrub activity. It could be more direct about when to choose this tool, but the guidance is clear enough.

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