readwise_export_highlights
Export all highlights from Readwise with optional filtering by date, book IDs, or deletion status for bulk analysis or backup purposes.
Instructions
Export all highlights from Readwise with optional filtering. Perfect for bulk analysis or backup.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| updatedAfter | No | Only export highlights updated after this date (ISO 8601) - useful for incremental sync | |
| ids | No | Comma-separated list of book IDs to export highlights from | |
| includeDeleted | No | Include deleted highlights in export (default: false) | |
| pageCursor | No | Cursor for pagination through large exports |
Implementation Reference
- The MCP tool handler function that executes the 'readwise_export_highlights' logic: initializes client, maps args to params, calls client.exportHighlights, formats response as MCP content.export async function handleExportHighlights(args: any) { const client = await initializeClient(); const params = { updatedAfter: args.updatedAfter, ids: args.ids, includeDeleted: args.includeDeleted, pageCursor: args.pageCursor, }; const response = await client.exportHighlights(params); return { content: [ { type: 'text', text: JSON.stringify(response.data, null, 2), }, ], }; }
- Tool schema defining the name, description, and inputSchema parameters for 'readwise_export_highlights'.{ name: 'readwise_export_highlights', description: 'Export all highlights from Readwise with optional filtering. Perfect for bulk analysis or backup.', inputSchema: { type: 'object', properties: { updatedAfter: { type: 'string', description: 'Only export highlights updated after this date (ISO 8601) - useful for incremental sync', }, ids: { type: 'string', description: 'Comma-separated list of book IDs to export highlights from', }, includeDeleted: { type: 'boolean', description: 'Include deleted highlights in export (default: false)', }, pageCursor: { type: 'string', description: 'Cursor for pagination through large exports', }, }, additionalProperties: false, }, },
- src/handlers/index.ts:8-16 (registration)Import registration of the handleExportHighlights function from highlights-handlers.js into the main handler dispatcher.import { handleListHighlights, handleCreateHighlight, handleExportHighlights, handleGetDailyReview, handleListBooks, handleGetBookHighlights, handleSearchHighlights, } from './highlights-handlers.js';
- src/handlers/index.ts:45-46 (registration)Dispatch registration in the main handleToolCall switch statement mapping tool name to handler.case 'readwise_export_highlights': return handleExportHighlights(args);
- src/readwise-client.ts:349-371 (helper)Core helper method in ReadwiseClient that makes the actual API request to Readwise /export/ endpoint with query parameters, handles errors including rate limits.async exportHighlights(params: ExportHighlightsParams = {}): Promise<APIResponse<ExportHighlightsResponse>> { try { const searchParams = new URLSearchParams(); Object.entries(params).forEach(([key, value]) => { if (value !== undefined) { searchParams.append(key, String(value)); } }); const query = searchParams.toString(); const endpoint = `/export/${query ? `?${query}` : ''}`; const result = await this.makeRequest<ExportHighlightsResponse>(endpoint, {}, true); return this.createResponse(result); } catch (error) { if (error instanceof Error && error.message.startsWith('RATE_LIMIT:')) { const seconds = parseInt(error.message.split(':')[1], 10); throw new Error(`Rate limit exceeded. Too many requests. Please retry after ${seconds} seconds.`); } throw error; } }