refresh_series

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

With no annotations, the description carries the behavioral burden. It does disclose the important library-wide behavior when no id is given, but it does not mention whether this is asynchronous, whether it creates a command, or whether there are any side effects or cautions for refreshing the whole library.

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?

A single well-formed sentence that front-loads the action and source, then clearly states the conditional scope. Every word earns its place, with 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?

The tool is simple with one optional parameter, and the description covers the core behavior and scope well. However, with no output schema and no annotations, the description does not clarify return behavior, asynchronous command semantics, or safety implications of the whole-library refresh path.

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?

Schema coverage is 100%, and the series_id property already explains the omitted/whole-library behavior. The description adds only TVDB context, so it neither significantly compensates for missing schema info nor adds much beyond it.

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?

Identifies a specific action (refresh metadata), a specific source (TVDB), and a clear scope distinction (one series vs whole library when id is omitted). This makes it easy to distinguish from sibling tools like rescan_series, search_series, or update_series.

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 implies when to use the tool: refresh metadata from TVDB, with id omitted meaning whole library. However, it does not explicitly name alternatives or explain when not to use it, so usage guidance remains implicit rather than explicit.

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