sonarr_get_customformat

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

The readOnlyHint annotation already indicates this is a safe read operation. The description adds minimal behavioral context beyond that, such as no mention of error handling (e.g., 404 if not found) or return format. It does not contradict annotations, but it also does not enrich them.

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 a single sentence with no waste, though it suffers from a grammatical error ('formats' vs 'format'). It is appropriately brief and front-loaded, but the error slightly detracts from quality.

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 tool's simplicity (one parameter, output schema present), the description is adequate. It communicates the core function. It lacks supplementary details like 'returns 404 if not found' or 'use list_customformat to get all', but these are not critical for such a straightforward get-by-ID operation.

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 has 0% description coverage for the 'id' parameter, and the description only says 'by id', which repeats the parameter name without adding detail. However, the parameter is self-explanatory (an integer ID for custom formats), and the description implies its purpose enough for this simple case.

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 states the tool fetches a single custom format by ID, using the verb 'Fetch' and identifying the resource ('custom formats'). It is distinct from sibling tools like list_customformat (which retrieves all) and create/update/delete operations. Minor grammatical error ('formats' instead of 'format') does not obscure meaning.

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?

Usage is implied rather than explicitly stated. The description does not mention alternatives or specify when to use this over sonarr_list_customformat. However, it is evident that this tool is for fetching one specific record by ID, which provides basic guidance.

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