dashbrr_get_tailscale_devices

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

Annotations already declare readOnlyHint=true, and the description adds meaningful context by specifying the exact return JSON structure and the parameter fallback logic. It does not cover error behavior (e.g., when no Tailscale instance exists), but for a simple read-only list tool, this is adequate.

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 sentences, front-loaded with the core purpose, and every clause adds value (return format, parameter options, fallback). No filler or redundant information.

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 read-only list tool with output schema and readOnlyHint annotations, the description covers the essential aspects: purpose, parameters, fallback, and return shape. It omits edge cases like missing configuration or error responses, but these are minor for this tool's simplicity.

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 description coverage is 0%, so the description must compensate. It explains both parameters: instance_id (a type-prefixed Tailscale instance from settings) and api_key (raw Tailscale key), and clarifies the either/or relationship with fallback. No examples or detailed format are given, but the meaning is clear.

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 resource ('Tailscale devices on the tailnet') and the operation is a get/list, implied by the tool name and the return format shown. It distinguishes unambiguously from sibling tools, which all target different services (Plex, Sonarr, Traefik, etc.).

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 provides clear context on how to invoke the tool: pass either instance_id or api_key, with a fallback to the first Tailscale-configured instance if neither is given. It does not explicitly state when not to use it or name alternatives, but the tool's scope is self-evident from the name and siblings.

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