radarr_get_naming

Instructions

Implementation Reference

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

  Tool 'radarr_get_naming' is registered dynamically via addConfigTools() when clients.radarr is configured. The function creates a tool with name `${serviceName}_get_naming` (line 171), schema with no required params (lines 173-177), and description about file naming configuration (line 172).

  {
    name: `${serviceName}_get_naming`,
    description: `Get file naming configuration from ${displayName}. Shows naming patterns for files and folders.`,
    inputSchema: {
      type: "object" as const,
      properties: {},
      required: [],
    },
  },

• src/index.ts:1299-1313 (handler)

  The handler for 'radarr_get_naming' (and similarly 'sonarr_get_naming', 'lidarr_get_naming') is in the switch/case at lines 1300-1313. It extracts the service name from the tool name, gets the client, calls client.getNamingConfig(), and returns the naming configuration as JSON.

  // Naming config
  case "sonarr_get_naming":
  case "radarr_get_naming":
  case "lidarr_get_naming": {
    const serviceName = name.split('_')[0] as keyof typeof clients;
    const client = clients[serviceName];
    if (!client) throw new Error(`${serviceName} not configured`);
    const naming = await client.getNamingConfig();
    return {
      content: [{
        type: "text",
        text: JSON.stringify(naming, null, 2),
      }],
    };
  }

• src/arr-client.ts:490-495 (helper)

  The getNamingConfig() method on the base ArrClient class (line 493) makes a GET request to '/config/naming' and returns a NamingConfig object. This is inherited by RadarrClient and all other service clients.

  /**
   * Get naming configuration
   */
  async getNamingConfig(): Promise<NamingConfig> {
    return this.request<NamingConfig>('/config/naming');
  }

• src/arr-client.ts:286-306 (schema)

  The NamingConfig interface (lines 286-306) defines the shape of the naming configuration returned by getNamingConfig(). It includes fields like renameMovies, movieFolderFormat, standardMovieFormat (for Radarr), and renameEpisodes, seriesFolderFormat etc. (for Sonarr/Lidarr).

  export interface NamingConfig {
    renameEpisodes?: boolean;
    replaceIllegalCharacters: boolean;
    colonReplacementFormat?: string;
    standardEpisodeFormat?: string;
    dailyEpisodeFormat?: string;
    animeEpisodeFormat?: string;
    seriesFolderFormat?: string;
    seasonFolderFormat?: string;
    specialsFolderFormat?: string;
    multiEpisodeStyle?: number;
    // Radarr
    renameMovies?: boolean;
    movieFolderFormat?: string;
    standardMovieFormat?: string;
    // Lidarr
    renameTracks?: boolean;
    artistFolderFormat?: string;
    albumFolderFormat?: string;
    trackFormat?: string;
  }