qbittorrent_sync_maindata

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

Beyond the readOnlyHint annotation, the description discloses key behavioral details: differential updates via rid, the meaning of full_update=true, and the included data categories. This adds meaningful context without contradicting the annotation.

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 front-loaded with the core purpose followed by usage essentials. Every word earns its place; there is no redundancy or 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?

Given the simple one-parameter schema, readOnly annotation, and presence of an output schema, the description sufficiently explains differential syncing, the rid round-trip, and response content. It fully equips an agent to call and interpret this tool correctly.

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 schema provides only a bare 'rid' integer with a default of 0 and no description. The description compensates by explaining that rid comes from the previous reply and that passing it yields only changes, which is essential and not inferable from the schema alone.

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 clearly identifies the tool as a 'Differential state snapshot for UI sync' and specifies it includes 'torrents, categories, tags and server_state.' While it lacks an explicit action verb like 'get' or 'list', the resource and scope are clear and differentiate it from sibling sync tools like qbittorrent_sync_torrent_peers.

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 explains how to use the rid parameter and what full_update=true signifies, giving clear context for incremental use. It does not explicitly name alternatives or when not to use this tool, but the UI sync context and differential state behavior imply the appropriate usage scenario.

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