Skip to main content
Glama

replication_list

Read-only

List TrueNAS replication tasks with name, direction, transport, and state to monitor progress, catch errors, and check last snapshot or run.

Instructions

[READ] List replication tasks with name, direction, transport, state.

state is the replication task's own state — PENDING / RUNNING / FINISHED / ERROR / HOLD, matching what the appliance UI shows — and is never absent, PENDING being what a task reports before its first run. An ERROR row carries the appliance's error sentence naming what to fix. Also returns lastSnapshot and lastRun (epoch milliseconds).

Args: target: TrueNAS target name from config; omit to use the default.

Input Schema

NameRequiredDescriptionDefault
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true, and the description goes well beyond that: it explains that state is never absent (PENDING before first run), that ERROR rows carry an appliance-supplied error sentence naming what to fix, and that lastSnapshot/lastRun are returned in epoch milliseconds. This is exactly the kind of runtime behavior an agent needs and cannot get from the schema.

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?

The summary line is front-loaded and the state/return-value detail is placed after it, then the args block. It is slightly verbose in the state enumeration, but every sentence conveys operational meaning rather than filler.

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 no output schema, the description correctly takes on the burden of describing return content (state values, error sentence, lastSnapshot, lastRun). It is nearly complete; it does not mention ordering, filtering, or result size for a list operation, which is a minor remaining gap.

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 schema alone would leave the single target parameter undocumented. The description compensates by defining target as a TrueNAS target name from config and stating that omitting it falls back to the default, which is the key semantic an agent needs.

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?

Opens with a specific verb and resource ("List replication tasks") plus the exact fields returned (name, direction, transport, state), and the [READ] tag marks it as a non-mutating inspection tool. It is clearly distinguishable from siblings like cloudsync_list and snapshot_list, which cover different resources.

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

Usage Guidelines3/5

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

The only usage guidance is the target parameter's default behavior ("omit to use the default"). There is no statement of when to reach for this tool over cloudsync_list or snapshot_list, and no prerequisites or exclusions are given, leaving usage to inference from the name.

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