arr_status
Check the operational status of all configured *arr media services including Sonarr, Radarr, Lidarr, Readarr, and Prowlarr to monitor your media management applications.
Instructions
Get status of all configured *arr services. Currently configured: Sonarr (TV), Radarr (Movies), Lidarr (Music), Readarr (Books), Prowlarr (Indexers)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:760-791 (handler)Main handler for the 'arr_status' tool. Loops through configured *arr services, calls getStatus() on each client, compiles connection/version status into a JSON object, includes unconfigured services, and returns as text content.case "arr_status": { const statuses: Record<string, unknown> = {}; for (const service of configuredServices) { try { const client = clients[service.name]; if (client) { const status = await client.getStatus(); statuses[service.name] = { configured: true, connected: true, version: status.version, appName: status.appName, }; } } catch (error) { statuses[service.name] = { configured: true, connected: false, error: error instanceof Error ? error.message : String(error), }; } } // Add unconfigured services for (const service of services) { if (!statuses[service.name]) { statuses[service.name] = { configured: false }; } } return { content: [{ type: "text", text: JSON.stringify(statuses, null, 2) }], }; }
- src/index.ts:92-99 (registration)Tool registration in the TOOLS array, including name, dynamic description based on configured services, and empty input schema (no parameters required).name: "arr_status", description: `Get status of all configured *arr services. Currently configured: ${configuredServices.map(s => s.displayName).join(', ')}`, inputSchema: { type: "object" as const, properties: {}, required: [], }, },
- src/index.ts:95-99 (schema)Input schema definition for arr_status tool: empty object with no properties or required fields.type: "object" as const, properties: {}, required: [], }, },
- src/arr-client.ts:485-487 (helper)Helper method in base ArrClient class that performs the actual API call to /api/v3/system/status, used by all *arr clients in the arr_status handler.async getStatus(): Promise<SystemStatus> { return this.request<SystemStatus>('/system/status'); }