Skip to main content
Glama

loadBackup

Restore or extract data from Heptabase backups by specifying the backup path and ID, enabling access to archived content for analysis or retrieval.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
backupIdNo
backupPathNo
extractNo

Implementation Reference

  • The main handler function for the 'loadBackup' tool, which resolves the backup path (by ID if provided), calls BackupManager.loadBackup, initializes/updates the data service with the backup data, and returns a success message.
    handler: async (params) => {
      if (!this.backupManager) {
        this.backupManager = new BackupManager({
          backupPath: this.config.backupPath,
          extractionPath: this.config.extractionPath,
          autoExtract: params.extract ?? this.config.autoExtract,
          watchDirectory: false,
          keepExtracted: this.config.keepExtracted
        });
      }
    
      let backupPath = params.backupPath;
    
      // If backupId is provided, find the backup path
      if (params.backupId) {
        const backups = await this.backupManager.listBackups();
        const backup = backups.find(b => b.backupId === params.backupId);
        if (!backup) {
          throw new Error('Backup not found');
        }
        backupPath = backup.backupPath;
      }
    
      const metadata = await this.backupManager.loadBackup(backupPath!);
    
      // Initialize data service with the extracted path
      const dataPath = metadata.extractedPath || path.dirname(metadata.backupPath);
      
      // Update existing data service if it exists, otherwise create new one
      if (this.dataService) {
        // Update the data path and reload
        (this.dataService as any).config.dataPath = dataPath;
        await this.dataService.loadData();
      } else {
        this.dataService = new HeptabaseDataService({
          dataPath,
          cacheEnabled: this.config.cacheEnabled,
          cacheTTL: this.config.cacheTTL
        });
        await this.dataService.loadData();
      }
    
      return {
        content: [{
          type: 'text',
          text: `Backup loaded successfully: ${metadata.backupId}`
        }]
      };
    }
  • Zod input schema for the loadBackup tool, validating backupPath or backupId (required at least one), and optional extract flag.
    const loadBackupSchema = z.object({
      backupPath: z.string().optional(),
      backupId: z.string().optional(),
      extract: z.boolean().optional()
    }).refine(data => data.backupPath || data.backupId, {
      message: 'Either backupPath or backupId must be provided'
    });
  • src/server.ts:273-280 (registration)
    Registration of the 'loadBackup' tool with the MCP server, providing inline schema (mirroring loadBackupSchema) and handler that validates params and delegates to this.tools.loadBackup.handler.
    this.server.tool('loadBackup', {
      backupPath: z.string().optional(),
      backupId: z.string().optional(),
      extract: z.boolean().optional()
    }, async (params) => {
      const validated = loadBackupSchema.parse(params);
      return this.tools.loadBackup.handler(validated);
    });
  • Core helper method in BackupManager class that performs the actual backup loading: stats file, extracts ZIP if configured and needed, builds and caches BackupMetadata, emits events.
    async loadBackup(backupPath: string): Promise<BackupMetadata> {
      this.emit('backup:load:start', backupPath);
    
      try {
        const stats = await fs.stat(backupPath);
        const fileName = path.basename(backupPath);
        const backupInfo = this.getBackupInfo(fileName);
        const isCompressed = fileName.endsWith('.zip');
        
        let extractedPath: string | undefined;
        
        if (isCompressed && this.config.autoExtract) {
          const backupName = path.basename(backupPath, '.zip');
          extractedPath = path.join(this.config.extractionPath, backupName);
          
          // Check if already extracted
          if (!(await fs.pathExists(extractedPath))) {
            await this.extractBackup(backupPath, extractedPath);
          }
        }
    
        const metadata: BackupMetadata = {
          backupId: path.basename(backupPath, path.extname(backupPath)),
          backupPath,
          createdDate: backupInfo.date,
          fileSize: stats.size,
          isCompressed,
          extractedPath,
          version: backupInfo.version
        };
    
        this.loadedBackups.set(metadata.backupId, metadata);
        this.emit('backup:load:complete', metadata);
        
        return metadata;
      } catch (error) {
        this.emit('backup:load:error', error);
        throw error;
      }
    }
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LarryStanley/heptabase-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server