dashbrr_get_sabnzbd_summary

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

The readOnlyHint annotation already establishes the safety profile, and the description adds that the result includes queue and recent failures. However, it doesn't disclose other behavioral traits like data freshness, pagination, or any read-side effects. It neither contradicts nor significantly enriches the annotations.

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?

The description is two concise sentences. The first sentence clearly states the tool's purpose, and the second provides the essential parameter format hint. There is no filler, repetition, or unnecessary detail, making it highly efficient.

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 read-only getter with one parameter and an output schema, the description covers the key input requirement and what the tool returns. It doesn't explain what 'recent failures' means in terms of time window, and it omits any intended usage context, but the existence of an output schema reduces the need to describe return values.

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 input schema only defines instance_id as a string with no description. The description adds a critical requirement: it must be type-prefixed (e.g., 'sabnzbd-0'). This provides actionable formatting guidance beyond the schema, which otherwise leaves the parameter ambiguous.

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 states the tool returns 'SABnzbd queue plus recent failures', which is a specific scope and distinguishes it from sibling summary tools for other services like NZBGet or Bazarr. The verb 'get' is implied by the tool name, and the description clarifies what the summary contains.

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 offers no guidance on when to use this tool versus alternatives such as dashbrr_get_nzbget_summary or dashbrr_get_bazarr_summary. It also lacks prerequisites or exclusions. The only usage-related hint is the instance_id type-prefix requirement, which is more about parameter formatting than tool selection.

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