Skip to main content
Glama

configureBackupPath

Set and manage backup path for Heptabase MCP to enable data retrieval, analysis, and export. Define path, monitor changes, and auto-extract data as needed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
autoExtractNo
pathYes
watchForChangesNo

Implementation Reference

  • The core handler function for the 'configureBackupPath' tool. It updates the server configuration with the provided backup path and optional flags, initializes or updates the BackupManager instance, and starts/stops directory watching as needed.
    this.tools.configureBackupPath = {
      inputSchema: configureBackupPathSchema,
      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}`
          }]
        };
      }
    };
  • Zod schema defining the input parameters for the configureBackupPath tool: required path (string), 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)
    Registers the 'configureBackupPath' tool with the MCP server, using the defined schema and delegating to the tool's handler.
    this.server.tool('configureBackupPath', configureBackupPathSchema.shape, async (params) => {
      return this.tools.configureBackupPath.handler(params);
    });
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/heptabse-mcp'

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