radarr_get_health
Get health check warnings and issues from Radarr. Shows any problems detected by the movie management application.
Instructions
Get health check warnings and issues from Radarr (Movies). Shows any problems detected by the application.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:143-151 (registration)The tool 'radarr_get_health' is registered via the addConfigTools('radarr', 'Radarr (Movies)') call on line 202, which dynamically creates the tool definition at lines 143-151 with name `${serviceName}_get_health`.
{ name: `${serviceName}_get_health`, description: `Get health check warnings and issues from ${displayName}. Shows any problems detected by the application.`, inputSchema: { type: "object" as const, properties: {}, required: [], }, }, - src/index.ts:201-203 (registration)The addConfigTools function is called for radarr here, triggering registration of radarr_get_health tool.
if (clients.sonarr) addConfigTools('sonarr', 'Sonarr (TV)'); if (clients.radarr) addConfigTools('radarr', 'Radarr (Movies)'); if (clients.lidarr) addConfigTools('lidarr', 'Lidarr (Music)'); - src/index.ts:1219-1242 (handler)Handler for the 'radarr_get_health' tool case in the switch statement. Extracts service name from tool name, calls client.getHealth(), and returns formatted JSON with issue count, issues (source, type, message, wikiUrl), and overall status.
// Health checks case "sonarr_get_health": case "radarr_get_health": case "lidarr_get_health": { const serviceName = name.split('_')[0] as keyof typeof clients; const client = clients[serviceName]; if (!client) throw new Error(`${serviceName} not configured`); const health = await client.getHealth(); return { content: [{ type: "text", text: JSON.stringify({ issueCount: health.length, issues: health.map(h => ({ source: h.source, type: h.type, message: h.message, wikiUrl: h.wikiUrl, })), status: health.length === 0 ? 'healthy' : 'issues detected', }, null, 2), }], }; } - src/arr-client.ts:504-509 (helper)The getHealth() method on the base ArrClient class which handles the actual API call to /health endpoint. Both SonarrClient and RadarrClient inherit this method.
/** * Get health check issues */ async getHealth(): Promise<HealthCheck[]> { return this.request<HealthCheck[]>('/health'); } - src/arr-client.ts:331-336 (schema)The HealthCheck interface defining the shape of health check data returned from the API (source, type, message, wikiUrl).
export interface HealthCheck { source: string; type: string; message: string; wikiUrl: string; }