configureBackupPath
Set the backup path for Heptabase MCP to enable data retrieval and monitoring. Configure options to watch for changes and auto-extract backups for efficient analysis and export.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| autoExtract | No | ||
| path | Yes | ||
| watchForChanges | No |
Implementation Reference
- src/server.ts:110-157 (handler)The handler function that executes the configureBackupPath tool logic. It updates the server configuration with the provided backup path, optional autoExtract and watchDirectory settings, initializes or updates the BackupManager instance, and starts/stops directory watching if applicable. Returns a success message.handler: async (params) => { this.config.backupPath = params.path; if (params.autoExtract !== undefined) { this.config.autoExtract = params.autoExtract; } if (params.watchForChanges !== undefined) { this.config.watchDirectory = params.watchForChanges; } // Update existing backup manager config if it exists if (this.backupManager) { this.backupManager.config.backupPath = this.config.backupPath; this.backupManager.config.autoExtract = this.config.autoExtract; this.backupManager.config.watchDirectory = this.config.watchDirectory; if (this.config.watchDirectory) { this.backupManager.startWatching(); } else { this.backupManager.stopWatching(); } } else { // Create new backup manager if it doesn't exist this.backupManager = new BackupManager({ backupPath: this.config.backupPath, extractionPath: this.config.extractionPath, autoExtract: this.config.autoExtract, watchDirectory: this.config.watchDirectory, keepExtracted: this.config.keepExtracted, maxBackups: this.config.maxBackups }); if (this.config.watchDirectory) { this.backupManager.startWatching(); } } // Don't save configuration to file in MCP mode to avoid EROFS errors // Configuration is managed through environment variables return { content: [{ type: 'text', text: `Backup path configured successfully: ${params.path}` }] }; }
- src/server.ts:102-106 (schema)Zod input schema for the configureBackupPath tool, defining required 'path' (non-empty string) and optional 'watchForChanges' and 'autoExtract' booleans.const configureBackupPathSchema = z.object({ path: z.string().min(1), watchForChanges: z.boolean().optional(), autoExtract: z.boolean().optional() });
- src/server.ts:160-162 (registration)MCP server tool registration for 'configureBackupPath', using the defined schema and delegating to the internal tools.configureBackupPath.handler.this.server.tool('configureBackupPath', configureBackupPathSchema.shape, async (params) => { return this.tools.configureBackupPath.handler(params); });