readarr_get_root_folders
Retrieve root folder paths, storage availability, and unmapped folders from Readarr to manage book library organization and storage allocation.
Instructions
Get root folders and storage info from Readarr (Books). Shows paths, free space, and unmapped folders.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:856-880 (handler)Handler for readarr_get_root_folders tool: extracts service name, retrieves ReadarrClient instance, calls getRootFoldersDetailed(), formats and returns root folder details including free space and unmapped folder count.case "sonarr_get_root_folders": case "radarr_get_root_folders": case "lidarr_get_root_folders": case "readarr_get_root_folders": { const serviceName = name.split('_')[0] as keyof typeof clients; const client = clients[serviceName]; if (!client) throw new Error(`${serviceName} not configured`); const folders = await client.getRootFoldersDetailed(); return { content: [{ type: "text", text: JSON.stringify({ count: folders.length, folders: folders.map(f => ({ id: f.id, path: f.path, accessible: f.accessible, freeSpace: formatBytes(f.freeSpace), freeSpaceBytes: f.freeSpace, unmappedFolders: f.unmappedFolders?.length || 0, })), }, null, 2), }], }; }
- src/index.ts:127-134 (registration)Registers the readarr_get_root_folders tool in the TOOLS array via dynamic template in addConfigTools function (called for readarr service). Defines name, description, and empty input schema.name: `${serviceName}_get_root_folders`, description: `Get root folders and storage info from ${displayName}. Shows paths, free space, and unmapped folders.`, inputSchema: { type: "object" as const, properties: {}, required: [], }, },
- src/index.ts:129-132 (schema)Input schema for readarr_get_root_folders tool: empty object (no parameters required).inputSchema: { type: "object" as const, properties: {}, required: [],
- src/arr-client.ts:578-580 (helper)Core helper method getRootFoldersDetailed() in ArrClient (extended by ReadarrClient) that performs the actual API request to fetch detailed root folder information from /rootfolder endpoint.async getRootFoldersDetailed(): Promise<RootFolder[]> { return this.request<RootFolder[]>('/rootfolder'); }
- src/arr-client.ts:406-412 (schema)Type definition for RootFolder interface used in getRootFoldersDetailed() response, including unmappedFolders for detailed storage info.export interface RootFolder { id: number; path: string; accessible: boolean; freeSpace: number; unmappedFolders?: Array<{ name: string; path: string }>; }