readarr_get_health
Retrieve health check warnings and issues from Readarr to identify problems detected in your book management system.
Instructions
Get health check warnings and issues from Readarr (Books). Shows any problems detected by the application.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:830-853 (handler)Main handler for the 'readarr_get_health' tool. Parses the tool name to get the service, retrieves the ReadarrClient instance, calls getHealth(), formats the health issues into JSON, and returns as text content.
case "sonarr_get_health": case "radarr_get_health": case "lidarr_get_health": case "readarr_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/index.ts:118-125 (schema)Tool schema definition for readarr_get_health (and other *_get_health tools). Defines name, description, and empty input schema (no parameters required).
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:175-179 (registration)Registration of configuration tools including readarr_get_health. Conditionally adds the tool to the TOOLS array if Readarr client is configured.
if (clients.sonarr) addConfigTools('sonarr', 'Sonarr (TV)'); if (clients.radarr) addConfigTools('radarr', 'Radarr (Movies)'); if (clients.lidarr) addConfigTools('lidarr', 'Lidarr (Music)'); if (clients.readarr) addConfigTools('readarr', 'Readarr (Books)'); - src/arr-client.ts:562-566 (helper)Core getHealth() method in ArrClient (inherited by ReadarrClient). Makes API request to /health endpoint to fetch health checks.
* Get health check issues */ async getHealth(): Promise<HealthCheck[]> { return this.request<HealthCheck[]>('/health'); } - src/arr-client.ts:394-399 (schema)Type definition for HealthCheck interface used by getHealth() method.
export interface HealthCheck { source: string; type: string; message: string; wikiUrl: string; }