replication_list

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

Indicates read-only with '[READ]' header, which is useful. No other behavioral traits disclosed (e.g., no pagination, no limit, no side effects). Since no annotations exist, the description carries full burden; it meets minimum but could add more context.

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?

Extremely concise: two short sentences plus parameter help. Every word earns its place, no 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?

For a simple list tool with one optional parameter and no output schema, the description covers the essential: what it lists, expected fields, and parameter usage. Could mention what happens if no tasks exist, but not critical.

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 description explains the only parameter 'target' with purpose and default behavior, adding significant meaning beyond the raw schema (string|null). Schema coverage is 0%, so description compensates well.

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 the tool lists replication tasks with specific fields (name, direction, transport, state). The verb 'List' and resource are clear. However, it does not explicitly distinguish from sibling list tools, though the name 'replication_list' provides some differentiation.

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?

Describes the 'target' parameter usage ('TrueNAS target name from config; omit to use the default'), but does not explain when to use this tool over alternatives or any exclusions. Usage is implied but not formally guided.

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