MCP *arr Server

Instructions

Implementation Reference

• src/index.ts:950-1054 (handler)

  Handler for lidarr_review_setup (and similar for other services): Fetches comprehensive configuration data from Lidarr including status, health checks, quality profiles, root folders, download clients, naming config, indexers, and metadata profiles (Lidarr-specific), then structures and returns it as JSON.

  case "sonarr_review_setup":
  case "radarr_review_setup":
  case "lidarr_review_setup":
  case "readarr_review_setup": {
    const serviceName = name.split('_')[0] as keyof typeof clients;
    const client = clients[serviceName];
    if (!client) throw new Error(`${serviceName} not configured`);
  
    // Gather all configuration data
    const [status, health, qualityProfiles, qualityDefinitions, downloadClients, naming, mediaManagement, rootFolders, tags, indexers] = await Promise.all([
      client.getStatus(),
      client.getHealth(),
      client.getQualityProfiles(),
      client.getQualityDefinitions(),
      client.getDownloadClients(),
      client.getNamingConfig(),
      client.getMediaManagement(),
      client.getRootFoldersDetailed(),
      client.getTags(),
      client.getIndexers(),
    ]);
  
    // For Lidarr/Readarr, also get metadata profiles
    let metadataProfiles = null;
    if (serviceName === 'lidarr' && clients.lidarr) {
      metadataProfiles = await clients.lidarr.getMetadataProfiles();
    } else if (serviceName === 'readarr' && clients.readarr) {
      metadataProfiles = await clients.readarr.getMetadataProfiles();
    }
  
    const review = {
      service: serviceName,
      version: status.version,
      appName: status.appName,
      platform: {
        os: status.osName,
        isDocker: status.isDocker,
      },
      health: {
        issueCount: health.length,
        issues: health,
      },
      storage: {
        rootFolders: rootFolders.map(f => ({
          path: f.path,
          accessible: f.accessible,
          freeSpace: formatBytes(f.freeSpace),
          freeSpaceBytes: f.freeSpace,
          unmappedFolderCount: f.unmappedFolders?.length || 0,
        })),
      },
      qualityProfiles: qualityProfiles.map(p => ({
        id: p.id,
        name: p.name,
        upgradeAllowed: p.upgradeAllowed,
        cutoff: p.cutoff,
        allowedQualities: p.items
          .filter(i => i.allowed)
          .map(i => i.quality?.name || i.name || (i.items?.map(q => q.quality.name).join(', ')))
          .filter(Boolean),
        customFormatsWithScores: p.formatItems?.filter(f => f.score !== 0).length || 0,
        minFormatScore: p.minFormatScore,
      })),
      qualityDefinitions: qualityDefinitions.map(d => ({
        quality: d.quality.name,
        minSize: d.minSize + ' MB/min',
        maxSize: d.maxSize === 0 ? 'unlimited' : d.maxSize + ' MB/min',
        preferredSize: d.preferredSize + ' MB/min',
      })),
      downloadClients: downloadClients.map(c => ({
        name: c.name,
        type: c.implementationName,
        protocol: c.protocol,
        enabled: c.enable,
        priority: c.priority,
      })),
      indexers: indexers.map(i => ({
        name: i.name,
        protocol: i.protocol,
        enableRss: i.enableRss,
        enableAutomaticSearch: i.enableAutomaticSearch,
        enableInteractiveSearch: i.enableInteractiveSearch,
        priority: i.priority,
      })),
      naming: naming,
      mediaManagement: {
        recycleBin: mediaManagement.recycleBin || 'not set',
        recycleBinCleanupDays: mediaManagement.recycleBinCleanupDays,
        downloadPropersAndRepacks: mediaManagement.downloadPropersAndRepacks,
        deleteEmptyFolders: mediaManagement.deleteEmptyFolders,
        copyUsingHardlinks: mediaManagement.copyUsingHardlinks,
        importExtraFiles: mediaManagement.importExtraFiles,
        extraFileExtensions: mediaManagement.extraFileExtensions,
      },
      tags: tags.map(t => t.label),
      ...(metadataProfiles && { metadataProfiles }),
    };
  
    return {
      content: [{
        type: "text",
        text: JSON.stringify(review, null, 2),
      }],
    };
  }

• src/index.ts:163-170 (registration)

  Registration of lidarr_review_setup tool: Dynamically adds the tool to the TOOLS array with name 'lidarr_review_setup', description, and empty input schema via addConfigTools('lidarr', 'Lidarr (Music)') called at line 177.

    name: `${serviceName}_review_setup`,
    description: `Get comprehensive configuration review for ${displayName}. Returns all settings for analysis: quality profiles, download clients, naming, storage, indexers, health warnings, and more. Use this to analyze the setup and suggest improvements.`,
    inputSchema: {
      type: "object" as const,
      properties: {},
      required: [],
    },
  }

• src/index.ts:177-178 (registration)

  Conditional registration: Adds Lidarr-specific tools including lidarr_review_setup only if Lidarr client is configured.

  if (clients.lidarr) addConfigTools('lidarr', 'Lidarr (Music)');
  if (clients.readarr) addConfigTools('readarr', 'Readarr (Books)');

• src/index.ts:2044-2050 (helper)

  Helper function formatBytes used in the review handler to format free space and sizes in human-readable form.

  function formatBytes(bytes: number): string {
    if (bytes === 0) return '0 B';
    const k = 1024;
    const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
    const i = Math.floor(Math.log(bytes) / Math.log(k));
    return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
  }