download_list
List and filter Optimizely DXP downloads by status and type to monitor ongoing operations or review history, with pagination for large datasets.
Instructions
📥 List downloads with flexible filtering and pagination. REAL-TIME: <1s. Filter by status (active/completed/failed/all) to monitor ongoing downloads or review history. Filter by type (logs/database/all) to track specific operations. Use pagination (limit, offset) for large download histories. Returns download IDs, status, progress percentage, file info, and start/completion times. Use this to find downloadId for download_status() or download_cancel() calls. All parameters optional.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by status: active (running), completed (successful), failed (errors/cancelled), or all | active |
| type | No | Filter by download type | all |
| limit | No | Max results for history queries (1-100) | |
| offset | No | Pagination offset for history |
Implementation Reference
- The primary handler function for the 'download_list' tool. Validates input arguments, retrieves active and historical downloads from both log and database systems, applies filters by status and type, sorts and paginates results, formats unified download objects, and returns a structured response with a human-readable message.static async handleDownloadList(args: DownloadListArgs): Promise<any> { try { const { status = 'active', type = 'all', limit = 10, offset = 0 } = args; // Validate parameters const validStatuses = ['active', 'completed', 'failed', 'all']; if (!validStatuses.includes(status)) { return ResponseBuilder.invalidParams(`Invalid status: ${status}. Must be one of: ${validStatuses.join(', ')}`); } const validTypes = ['logs', 'database', 'all']; if (!validTypes.includes(type)) { return ResponseBuilder.invalidParams(`Invalid type: ${type}. Must be one of: ${validTypes.join(', ')}`); } if (limit < 0 || limit > 100) { return ResponseBuilder.invalidParams(`Invalid limit: ${limit}. Must be between 0 and 100`); } if (offset < 0) { return ResponseBuilder.invalidParams(`Invalid offset: ${offset}. Must be >= 0`); } // Get downloads from both systems // DXP-178 FIX: Need .default for ES module default export const DatabaseSimpleTools = require('./database-simple-tools').default; // Get log downloads const logDownloads = status === 'active' ? downloadManager.getActiveDownloads() : downloadManager.getHistory(1000); // Get all history for filtering // Get database downloads // DXP-177: Add null check to prevent "Cannot read properties of undefined (reading 'entries')" error const dbDownloadsArray = DatabaseSimpleTools.backgroundDownloads ? Array.from(DatabaseSimpleTools.backgroundDownloads.entries() as IterableIterator<[string, any]>) .map(([downloadId, download]) => ({ ...download, downloadId })) : []; // Apply status filter const filteredLogDownloads = this._filterByStatus(logDownloads, status); const filteredDbDownloads = this._filterByStatus(dbDownloadsArray, status); // Apply type filter let allDownloads: UnifiedDownload[] = []; if (type === 'all' || type === 'logs') { allDownloads.push(...filteredLogDownloads.map(d => this._formatLogDownload(d))); } if (type === 'all' || type === 'database') { allDownloads.push(...filteredDbDownloads.map(d => this._formatDatabaseDownload(d))); } // Sort by startTime (most recent first) allDownloads.sort((a, b) => b.startTime - a.startTime); // Apply pagination (only for non-active status) let paginatedDownloads = allDownloads; let hasMore = false; if (status !== 'active' && limit > 0) { paginatedDownloads = allDownloads.slice(offset, offset + limit); hasMore = allDownloads.length > offset + limit; } // Build message const message = this._buildDownloadListMessage(paginatedDownloads, status, type, hasMore, offset, limit); // Build structured data const structuredData = { downloads: paginatedDownloads, totalCount: paginatedDownloads.length, hasMore: hasMore }; return ResponseBuilder.successWithStructuredData(structuredData, message); } catch (error: any) { OutputLogger.error(`Download list error: ${error}`); return ResponseBuilder.internalError('Failed to list downloads', error.message); } }
- TypeScript interface defining the input arguments for the download_list tool, including optional parameters for filtering by status, type, pagination limit, and offset.interface DownloadListArgs { status?: 'active' | 'completed' | 'failed' | 'all'; type?: 'logs' | 'database' | 'all'; limit?: number; offset?: number; }
- Supporting helper methods that assist the handler in filtering, formatting downloads from different sources (logs and database), and building the response message.} /** * Filter downloads by status * @private */ static _filterByStatus(downloads: any[], status: string): any[] {