MCP *arr Server

Instructions

Implementation Reference

• src/index.ts:305-313 (registration)

  Registration of the 'radarr_get_queue' tool in the TOOLS array if Radarr client is configured. Defines the tool name, description, and empty input schema.
  { name: "radarr_get_queue", description: "Get Radarr download queue", inputSchema: { type: "object" as const, properties: {}, required: [], }, },
• src/index.ts:1232-1250 (handler)

  Tool handler in the switch statement for CallToolRequestSchema. Validates Radarr configuration, fetches queue via RadarrClient.getQueue(), computes progress percentages, and returns formatted JSON response.
  case "radarr_get_queue": { if (!clients.radarr) throw new Error("Radarr not configured"); const queue = await clients.radarr.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), }], }; }
• src/arr-client.ts:492-494 (helper)

  Core getQueue method in ArrClient base class (inherited by RadarrClient). Performs authenticated API GET request to the /queue endpoint with flags to include unknown series/movie items.
  async getQueue(): Promise<{ records: QueueItem[]; totalRecords: number }> { return this.request<{ records: QueueItem[]; totalRecords: number }>('/queue?includeUnknownSeriesItems=true&includeUnknownMovieItems=true'); }
• src/arr-client.ts:673-676 (helper)

  RadarrClient class extending ArrClient, initializing with service name 'radarr'. Provides the specific client instance used by the tool handler.
  export class RadarrClient extends ArrClient { constructor(config: ArrConfig) { super('radarr', config); }
• src/arr-client.ts:32-47 (schema)

  TypeScript interface defining the structure of queue items returned by the Radarr /queue API endpoint.
  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; }