Skip to main content
Glama

sonarr_get_queue

Retrieve the current download queue from Sonarr to monitor pending TV show episodes and track download progress.

Instructions

Get Sonarr download queue

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.ts:206-214 (registration)
    Registers the 'sonarr_get_queue' tool in the TOOLS array if Sonarr client is configured. Defines input schema as empty object.
    {
      name: "sonarr_get_queue",
      description: "Get Sonarr download queue",
      inputSchema: {
        type: "object" as const,
        properties: {},
        required: [],
      },
    },
  • MCP tool handler for 'sonarr_get_queue'. Fetches queue from SonarrClient, formats progress and returns as JSON text content.
    case "sonarr_get_queue": {
      if (!clients.sonarr) throw new Error("Sonarr not configured");
      const queue = await clients.sonarr.getQueue();
      return {
        content: [{
          type: "text",
          text: JSON.stringify({
            totalRecords: queue.totalRecords,
            items: queue.records.map(q => ({
              title: q.title,
              status: q.status,
              progress: ((1 - q.sizeleft / q.size) * 100).toFixed(1) + '%',
              timeLeft: q.timeleft,
              downloadClient: q.downloadClient,
            })),
          }, null, 2),
        }],
      };
    }
  • Core implementation in ArrClient.getQueue(), called by SonarrClient. Makes API request to /queue endpoint with parameters for unknown items.
    async getQueue(): Promise<{ records: QueueItem[]; totalRecords: number }> {
      return this.request<{ records: QueueItem[]; totalRecords: number }>('/queue?includeUnknownSeriesItems=true&includeUnknownMovieItems=true');
    }
  • TypeScript interface defining the QueueItem returned by the Sonarr /queue API.
    export interface QueueItem {
      id: number;
      title: string;
      status: string;
      trackedDownloadStatus: string;
      trackedDownloadState: string;
      statusMessages: Array<{ title: string; messages: string[] }>;
      downloadId: string;
      protocol: string;
      downloadClient: string;
      outputPath: string;
      sizeleft: number;
      size: number;
      timeleft: string;
      estimatedCompletionTime: string;
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Get Sonarr download queue' implies a read-only operation, but it doesn't specify whether this requires authentication, what data format is returned, if there are rate limits, or if the queue is real-time or cached. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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?

The description is a single, efficient phrase that conveys the core purpose without unnecessary words. It's front-loaded with the essential information ('Get Sonarr download queue') and contains no redundant or verbose elements. Every word earns its place.

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

Completeness3/5

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

Given the tool has 0 parameters, no annotations, and no output schema, the description is minimally adequate. It states what the tool does but lacks details on behavior, output format, or usage context. For a simple read operation, this might suffice, but the absence of output schema means the agent doesn't know what data to expect, leaving room for improvement.

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

Parameters4/5

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

The tool has 0 parameters, and schema description coverage is 100% (empty schema is fully described). The description doesn't need to add parameter semantics since there are none. A baseline of 4 is appropriate for a parameterless tool where the schema fully covers the absence of inputs.

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

Purpose4/5

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

The description 'Get Sonarr download queue' clearly states the verb ('Get') and resource ('Sonarr download queue'), making the purpose immediately understandable. It distinguishes from siblings like 'sonarr_get_calendar' or 'sonarr_get_series' by specifying the queue resource. However, it doesn't explicitly differentiate from 'lidarr_get_queue' or 'radarr_get_queue', which are similar tools for different media types.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention what the queue contains (e.g., pending downloads, active transfers), when it's appropriate to check it, or how it differs from other queue-related tools like 'lidarr_get_queue'. Without this context, an agent must infer usage from the tool name alone.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aplaceforallmystuff/mcp-arr'

If you have feedback or need assistance with the MCP directory API, please join our Discord server