Skip to main content
Glama

Instance options

get_instance_options
Read-only

Retrieve quality profiles, root folders, free space and tags for each Radarr, Sonarr, Whisparr or Lidarr instance, providing the exact IDs add_media and update_media require instead of guessing values.

Instructions

Quality profiles, root folders and tags of each Radarr, Sonarr, Whisparr and Lidarr instance: the values add_media and update_media need, so read them here, never guess. For health use get_stack_health. One row per instance: profiles with ids, root folders with free space and unmappedFolders, tags. An instance whose read fails is in degraded; an unknown instance is refused with the valid ones.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_instance_options"
  }
}

Input Schema

NameRequiredDescriptionDefault
serviceNo
instanceNoWhich instance (e.g. "4k") when several of this service exist. Omit it when there is one.

Output Schema

NameRequiredDescriptionDefault
itemsYes
degradedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.84.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only declare readOnlyHint, so the description carries the behavioral load and does it well: one row per instance, per-instance read failures surfaced in `degraded`, and unknown instance identifiers refused with the valid values returned. That is failure-mode and error-contract detail an agent cannot get from the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four tight sentences in a deliberate order: what it returns, why you need it, where to go instead, output shape, then failure behavior. No filler, and the primary payload is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so the brief 'one row per instance' summary is sufficient rather than redundant; with two optional-ish parameters and no nested objects, the definition covers everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%: `instance` is documented in the schema and `service` is self-documenting via its enum. The description adds a little semantics by explaining that a wrong `instance` is refused with the valid list, but says nothing about `service` beyond the enumerated values, so it neither compensates further nor repeats.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence enumerates the exact resource set (quality profiles, root folders, tags) per instance for four named services, and explicitly hands off health checks to get_stack_health. An agent can distinguish this from get_stack_health or get_library without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states the consuming tools by name (add_media, update_media) and the rule 'read them here, never guess', plus a negative routing case ('For health use get_stack_health'). The when-to-use condition is explicit rather than implied.

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