Skip to main content
Glama

lidarr_get_health

Check Lidarr music management application for health warnings and issues. Identifies problems detected by the system to maintain service reliability.

Instructions

Get health check warnings and issues from Lidarr (Music). Shows any problems detected by the application.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler logic for the 'lidarr_get_health' tool (shared with other *_get_health tools). Parses tool name to get service, retrieves the client, calls client.getHealth(), and formats the response with issue count, details, and status.
    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),
        }],
      };
    }
  • Tool schema definition for lidarr_get_health (dynamically generated via addConfigTools for 'lidarr'). 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:177-177 (registration)
    Conditional registration of lidarr tools (including lidarr_get_health) by calling addConfigTools when Lidarr client is configured.
    if (clients.lidarr) addConfigTools('lidarr', 'Lidarr (Music)');
  • Core helper method in ArrClient (inherited by LidarrClient) that implements the actual API call to fetch health checks from the Lidarr /health endpoint.
    async getHealth(): Promise<HealthCheck[]> {
      return this.request<HealthCheck[]>('/health');
    }
  • Initialization of LidarrClient instance from configuration, enabling the lidarr_get_health tool.
    case 'lidarr':
      clients.lidarr = new LidarrClient(config);
      break;
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It mentions that the tool 'Shows any problems detected by the application,' which implies a read-only, informational operation, but doesn't disclose behavioral traits such as whether it requires authentication, has rate limits, returns real-time or cached data, or what format the output takes. This leaves significant gaps for an agent to understand how to invoke it effectively.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and front-loaded, consisting of two clear sentences: the first states the purpose, and the second elaborates on what it shows. There's no wasted language, and it efficiently communicates the core functionality without unnecessary details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, no annotations, no output schema), the description is minimally adequate. It explains what the tool does but lacks context on behavioral aspects like output format, error handling, or integration with other tools. For a health check tool, more details on what constitutes 'health' or example issues would enhance completeness, but it's not entirely incomplete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter semantics, but since there are no parameters, this is acceptable. A baseline of 4 is appropriate as the schema fully covers the lack of parameters, and the description doesn't need to compensate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Get health check warnings and issues from Lidarr (Music).' It specifies the verb ('Get'), resource ('health check warnings and issues'), and domain ('Lidarr (Music)'). However, it doesn't explicitly differentiate from sibling tools like 'radarr_get_health' or 'sonarr_get_health', which have similar purposes but for different applications.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when it should be used (e.g., for monitoring, troubleshooting), when not to use it, or what other tools might be relevant (e.g., 'lidarr_get_queue' for queue issues). The phrase 'Shows any problems detected by the application' implies a diagnostic context but lacks explicit usage instructions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aplaceforallmystuff/mcp-arr'

If you have feedback or need assistance with the MCP directory API, please join our Discord server