lidarr_get_naming
Retrieve file naming patterns for folders and files from Lidarr music management. Shows current naming configuration.
Instructions
Get file naming configuration from Lidarr (Music). Shows naming patterns for files and folders.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:170-178 (registration)Tool 'lidarr_get_naming' is registered via the addConfigTools helper when Lidarr is configured (line 203). The name is dynamically generated as `${serviceName}_get_naming` where serviceName is 'lidarr'.
{ 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:171-178 (schema)Input schema for lidarr_get_naming: an empty object with no required parameters.
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)Handler for lidarr_get_naming (caught by case pattern 'sonarr_get_naming'/'radarr_get_naming'/'lidarr_get_naming'). It calls client.getNamingConfig() on the Lidarr client 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:286-306 (helper)The NamingConfig interface defines the shape of naming configuration data returned by the API (including Lidarr-specific fields: renameTracks, artistFolderFormat, albumFolderFormat, trackFormat).
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; } - src/arr-client.ts:490-495 (helper)The getNamingConfig() method on ArrClient (inherited by LidarrClient) calls the API endpoint '/config/naming'.
/** * Get naming configuration */ async getNamingConfig(): Promise<NamingConfig> { return this.request<NamingConfig>('/config/naming'); }