Skip to main content
Glama

cloudsync_list

Read-only

Lists cloud-sync tasks for a TrueNAS target with description, direction, path, and last run state to audit or troubleshoot synchronization jobs.

Instructions

[READ] List cloud-sync tasks with description, direction, path, state.

state here is the last run's job state (SUCCESS / FAILED / RUNNING) and is null until the task has run — cloud-sync records, unlike replication ones, carry no state of their own.

Args: target: TrueNAS target name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations only supply readOnlyHint=true, so the description carries the rest and does add real value: it explains that ``state`` reflects the last run's job state (SUCCESS/FAILED/RUNNING), that it is null until the task has run, and that cloud-sync records carry no state of their own unlike replication records. It does not mention pagination, ordering, or what an omitted target returns, which are the remaining gaps.

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 operation and returned fields, followed by a compact, high-value note on ``state`` semantics. The Args block is short; nothing feels padded, though the state paragraph is slightly verbose for the information conveyed.

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

Completeness3/5

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

For a single-parameter read-only list tool with no output schema, the description covers the returned fields and the non-obvious ``state`` semantics well. It stops short of explaining null/omitted ``target`` behavior and any filtering or pagination behavior, which an agent would need to call it confidently.

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

Parameters3/5

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

Schema description coverage is 0% with one optional parameter, so the description must compensate and partially does by defining ``target`` as the TrueNAS target name from config. It does not say what happens when target is null or omitted (all targets vs. none), leaving a meaningful behavioral ambiguity in the only parameter.

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

Purpose4/5

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

States a clear verb+resource ("List cloud-sync tasks") and enumerates the returned fields (description, direction, path, state). The aside that cloud-sync records "unlike replication ones, carry no state of their own" implicitly distinguishes it from the sibling replication_list, though the routing is left for the agent to infer.

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

Usage Guidelines2/5

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

No explicit when-to-use or when-not-to-use guidance, and no alternative tools are named. The only usage-adjacent information is the semantics of the ``state`` field and the origin of ``target``, which is data interpretation rather than task selection.

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