MCP *arr Server

Instructions

Implementation Reference

• src/index.ts:144-152 (registration)

  Registration of the lidarr_get_naming tool (via dynamic `${serviceName}_get_naming`) in the addConfigTools function, including its schema with no input 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:177-177 (registration)

  Invocation of addConfigTools for Lidarr service, which registers the lidarr_get_naming tool if Lidarr client is configured.
  if (clients.lidarr) addConfigTools('lidarr', 'Lidarr (Music)');
• src/arr-client.ts:344-369 (schema)

  TypeScript interface defining the structure of the naming configuration data returned by the tool.
  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; }
• src/index.ts:913-927 (handler)

  Main handler for lidarr_get_naming tool call: parses service name from tool name, retrieves LidarrClient instance, calls getNamingConfig(), and returns the result as formatted JSON text.
  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/arr-client.ts:547-552 (handler)

  Implementation of getNamingConfig method in base ArrClient (used by LidarrClient): performs HTTP GET request to /api/{apiVersion}/config/naming endpoint to fetch the naming configuration.
  /** * Get naming configuration */ async getNamingConfig(): Promise<NamingConfig> { return this.request<NamingConfig>('/config/naming'); }