MCP Firebird

Instructions

Implementation Reference

• src/tools/database.ts:405-434 (handler)

  MCP tool registration and handler for 'restore-database'. Parses arguments, calls restoreDatabase helper, formats response for Claude, handles errors.
  tools.set("restore-database", { name: "restore-database", description: "Restores a Firebird database from a backup", inputSchema: RestoreDatabaseArgsSchema, handler: async (request) => { const { backupPath, targetPath, options } = request; logger.info(`Executing restore-database tool from: ${backupPath} to: ${targetPath}`); try { const result = await restoreDatabase(backupPath, targetPath, options); return { content: [{ type: "text", text: formatForClaude(result) }] }; } catch (error) { const errorResponse = wrapError(error); logger.error(`Error restoring database: ${errorResponse.error} [${errorResponse.errorType || 'UNKNOWN'}]`); return { content: [{ type: "text", text: formatForClaude(errorResponse) }] }; } } });
• src/tools/database.ts:61-69 (schema)

  Zod input schema for the restore-database tool, validating backupPath, targetPath, and restore options.
  export const RestoreDatabaseArgsSchema = z.object({ backupPath: z.string().min(1).describe("Path to the backup file"), targetPath: z.string().min(1).describe("Path where the database will be restored"), options: z.object({ replace: z.boolean().default(false).describe("Whether to replace the target database if it exists"), pageSize: z.number().int().min(1024).max(16384).default(4096).describe("Page size for the restored database"), verbose: z.boolean().default(false).describe("Whether to show detailed progress") }).optional() });
• src/db/management.ts:205-318 (helper)

  The core restoreDatabase helper function that performs the actual database restoration using gbak or nbackup Firebird tools, with validation, error handling, and logging.
  export const restoreDatabase = async ( backupPath: string, targetPath: string, options: RestoreOptions = {}, config = DEFAULT_CONFIG ): Promise<RestoreResult> => { const startTime = Date.now(); try { // Check if Firebird tools are installed const toolsCheck = await checkFirebirdTools(); if (!toolsCheck.installed) { throw new FirebirdError( `Firebird client tools are not installed. ${toolsCheck.installInstructions}`, 'MISSING_FIREBIRD_TOOLS' ); } // Check if the backup file exists if (!fs.existsSync(backupPath)) { throw new FirebirdError( `Backup file not found: ${backupPath}`, 'FILE_NOT_FOUND' ); } // Check if the target database already exists if (fs.existsSync(targetPath) && !options.replace) { throw new FirebirdError( `Target database already exists: ${targetPath}. Use 'replace: true' to overwrite.`, 'FILE_EXISTS' ); } // Ensure the target directory exists const targetDir = path.dirname(targetPath); if (!fs.existsSync(targetDir)) { fs.mkdirSync(targetDir, { recursive: true }); } // Determine which restore tool to use based on the backup file extension const ext = path.extname(backupPath).toLowerCase(); let command: string; let args: string[] = []; // Try to find Firebird bin directory const firebirdBinPath = await findFirebirdBinPath(); if (ext === '.fbk' || ext === '.gbk') { // GBAK restore command = firebirdBinPath ? path.join(firebirdBinPath, 'gbak') : 'gbak'; args = [ '-c', // Create (restore) '-v', // Verbose output '-user', config.user || 'SYSDBA', '-password', config.password || 'masterkey' ]; // Set page size if specified if (options.pageSize) { args.push('-page_size', options.pageSize.toString()); } // Add backup path and target database path args.push(backupPath, targetPath); } else if (ext === '.nbk') { // NBACKUP restore command = firebirdBinPath ? path.join(firebirdBinPath, 'nbackup') : 'nbackup'; args = [ '-R', // Restore '-user', config.user || 'SYSDBA', '-password', config.password || 'masterkey' ]; // Add target database path and backup path args.push(targetPath, backupPath); } else { throw new FirebirdError( `Unknown backup file format: ${ext}`, 'CONFIGURATION_ERROR' ); } logger.info(`Starting database restore from ${backupPath} to ${targetPath}`); if (options.verbose) { logger.debug(`Restore command: ${command} ${args.join(' ')}`); } // Execute the restore command const result = await executeCommand(command, args, options.verbose); const duration = Date.now() - startTime; logger.info(`Restore completed successfully in ${duration}ms`); return { success: true, targetPath, duration, details: result }; } catch (error: any) { const duration = Date.now() - startTime; const errorMessage = `Error restoring database: ${error.message || error}`; logger.error(errorMessage); return { success: false, targetPath, duration, error: errorMessage, details: error.details || '' }; } };