lidarr_get_health
Retrieve health check warnings and issues from Lidarr to identify any problems detected by the application.
Instructions
Get health check warnings and issues from Lidarr (Music). Shows any problems detected by the application.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:1219-1242 (handler)The tool handler for lidarr_get_health (along with sonarr_get_health and radarr_get_health). It extracts the service name from the tool name, calls client.getHealth(), and returns the health check results as JSON.
// 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:331-336 (schema)The HealthCheck interface defining the shape of health check data returned from the API.
export interface HealthCheck { source: string; type: string; message: string; wikiUrl: string; } - src/arr-client.ts:507-509 (helper)The getHealth() method on ArrClient that makes the GET /api/v3/health (or v1 for Lidarr) API call to retrieve health check issues.
async getHealth(): Promise<HealthCheck[]> { return this.request<HealthCheck[]>('/health'); } - src/index.ts:143-151 (registration)The tool registration for lidarr_get_health (generated dynamically via addConfigTools). Created when Lidarr is configured, adding the tool with name 'lidarr_get_health', empty input schema, and description.
{ 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: [], }, },