dashbrr_get_ui_preferences_collapse

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

With readOnlyHint=true in annotations, the read-only behavior is already disclosed. The description adds the contextual scope of 'for the authenticated user' and clarifies what 'collapse preferences' means (which panels are collapsed), which goes beyond the annotation. No additional behavioral details are given, but the annotation covers the main safety aspect.

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, concise sentence that immediately communicates what is returned and for whom. There is no wasted verbiage or repetition of schema or annotation data.

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, parameterless read-only tool, the description fully covers what it returns and to whom it applies. An output schema exists and can describe the structure, so the description does not need to list return fields. The combination of description, annotations, and schema is sufficient for an agent to select and invoke 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 tool has zero parameters, which warrants a baseline of 4 per the rubric. The description does not need to explain parameter semantics since there are none, and the input schema is empty.

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 returns the current UI collapse preferences for the authenticated user, specifying which dashboard panels are collapsed. The 'get' in the tool name aligns with this, and the resource (UI collapse preferences) is distinct from sibling getters that focus on other systems like autobrr, jellyfin, or plex.

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 the tool is used when you need the current collapse state for the dashboard, but it does not explicitly mention when to use it instead of alternatives. The sibling 'set_ui_preference_collapse' indicates there is a counterpart for changing the preference, but no when/when-not guidance is provided beyond the straightforward purpose.

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