readarr_get_naming
Retrieve file and folder naming patterns configured in Readarr for organizing book files automatically.
Instructions
Get file naming configuration from Readarr (Books). Shows naming patterns for files and folders.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:912-927 (handler)Handler for readarr_get_naming (and other _get_naming tools): extracts ReadarrClient instance and calls getNamingConfig(), returns JSON response.// Naming config case "sonarr_get_naming": case "radarr_get_naming": case "lidarr_get_naming": case "readarr_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/index.ts:144-152 (registration)Tool registration and input schema definition for {serviceName}_get_naming (readarr_get_naming when serviceName='readarr') inside addConfigTools function, called at line 178 if Readarr configured.{ 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/arr-client.ts:550-552 (helper)Core implementation: ArrClient.getNamingConfig() (inherited by ReadarrClient) performs API GET to /api/v1/config/naming to fetch the naming config.async getNamingConfig(): Promise<NamingConfig> { return this.request<NamingConfig>('/config/naming'); }
- src/arr-client.ts:344-369 (schema)TypeScript interface defining the structure of the naming configuration data returned by Readarr API.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; // Readarr renameBooks?: boolean; authorFolderFormat?: string; bookFolderFormat?: string; standardBookFormat?: string; }