openclaw.plugin.json

{
  "id": "clawvault",
  "name": "ClawVault",
  "version": "3.5.0",
  "kind": "memory",
  "description": "Structured memory system for AI agents with context death resilience",
  "configSchema": {
    "type": "object",
    "properties": {
      "vaultPath": {
        "type": "string",
        "description": "Path to the ClawVault vault directory. Used as fallback when agentVaults is not set or agent not found."
      },
      "agentVaults": {
        "type": "object",
        "description": "Mapping of agent names to vault paths. Allows each agent to have its own vault. Falls back to vaultPath if agent not found.",
        "additionalProperties": {
          "type": "string",
          "description": "Path to the vault directory for this agent"
        }
      },
      "allowClawvaultExec": {
        "type": "boolean",
        "description": "Security gate for all child_process execution from the plugin. Must be true to run clawvault CLI commands.",
        "default": false
      },
      "clawvaultBinaryPath": {
        "type": "string",
        "description": "Optional absolute path to the clawvault executable. When omitted, the plugin resolves clawvault from PATH."
      },
      "clawvaultBinarySha256": {
        "type": "string",
        "description": "Optional SHA-256 checksum for clawvaultBinaryPath (or resolved clawvault executable) to enforce binary integrity verification."
      },
      "allowEnvAccess": {
        "type": "boolean",
        "description": "Allow reading OPENCLAW_* and CLAWVAULT_PATH environment variables for vault and agent discovery.",
        "default": false
      },
      "enableStartupRecovery": {
        "type": "boolean",
        "description": "Enable recovery checks on gateway startup.",
        "default": false
      },
      "enableSessionContextInjection": {
        "type": "boolean",
        "description": "Enable recap/context injection on session start.",
        "default": false
      },
      "enableAutoCheckpoint": {
        "type": "boolean",
        "description": "Enable automatic checkpointing on /new.",
        "default": false
      },
      "enableObserveOnNew": {
        "type": "boolean",
        "description": "Enable observer flush on /new.",
        "default": false
      },
      "enableHeartbeatObservation": {
        "type": "boolean",
        "description": "Enable observation threshold checks on heartbeat.",
        "default": false
      },
      "enableCompactionObservation": {
        "type": "boolean",
        "description": "Enable forced observer flush on compaction events.",
        "default": false
      },
      "enableWeeklyReflection": {
        "type": "boolean",
        "description": "Enable weekly reflection on Sunday midnight UTC.",
        "default": false
      },
      "enableFactExtraction": {
        "type": "boolean",
        "description": "Enable extraction of structured facts from observed text during hook events.",
        "default": false
      },
      "autoCheckpoint": {
        "type": "boolean",
        "description": "Deprecated alias for enableAutoCheckpoint.",
        "default": false
      },
      "observeOnHeartbeat": {
        "type": "boolean",
        "description": "Deprecated alias for enableHeartbeatObservation.",
        "default": false
      },
      "weeklyReflection": {
        "type": "boolean",
        "description": "Deprecated alias for enableWeeklyReflection.",
        "default": false
      },
      "contextProfile": {
        "type": "string",
        "enum": ["default", "planning", "incident", "handoff", "auto"],
        "description": "Default context profile for session start injection",
        "default": "auto"
      },
      "maxContextResults": {
        "type": "integer",
        "minimum": 1,
        "maximum": 20,
        "description": "Maximum number of context results to inject on session start",
        "default": 4
      },
      "enableBeforePromptRecall": {
        "type": "boolean",
        "description": "Enable before_prompt_build memory recall directives and vault context injection.",
        "default": true
      },
      "enableMessageSendingFilter": {
        "type": "boolean",
        "description": "Enable outbound message filtering via message_sending hook.",
        "default": true
      },
      "enforceCommunicationProtocol": {
        "type": "boolean",
        "description": "Append communication protocol rules to system context and enforce rewrites.",
        "default": true
      },
      "minQuestionRecallScore": {
        "type": "number",
        "minimum": 0,
        "maximum": 1,
        "description": "Minimum memory_search score used when checking outbound questions for existing answers.",
        "default": 0.35
      }
    },
    "additionalProperties": false
  },
  "uiHints": {
    "vaultPath": {
      "label": "Vault Path",
      "placeholder": "~/my-vault",
      "description": "Path to your ClawVault memory vault (fallback when agentVaults not set)"
    },
    "agentVaults": {
      "label": "Agent Vaults",
      "description": "Per-agent vault paths (e.g., {\"agent1\": \"/path/to/vault1\", \"agent2\": \"/path/to/vault2\"})"
    },
    "allowClawvaultExec": {
      "label": "Allow CLI Execution",
      "description": "Required opt-in to run child_process calls from the plugin."
    },
    "clawvaultBinaryPath": {
      "label": "ClawVault Binary Path",
      "description": "Absolute path to clawvault executable for stricter execution controls."
    },
    "clawvaultBinarySha256": {
      "label": "ClawVault Binary SHA-256",
      "description": "Optional checksum to verify executable integrity before execution."
    },
    "allowEnvAccess": {
      "label": "Allow Environment Access",
      "description": "Allow OPENCLAW_* and CLAWVAULT_PATH reads for fallback discovery."
    },
    "enableStartupRecovery": {
      "label": "Startup Recovery",
      "description": "Run recovery checks on gateway startup."
    },
    "enableSessionContextInjection": {
      "label": "Session Context Injection",
      "description": "Inject recap and memory context on session start."
    },
    "enableAutoCheckpoint": {
      "label": "Auto Checkpoint",
      "description": "Automatically checkpoint before /new."
    },
    "enableObserveOnNew": {
      "label": "Observe On /new",
      "description": "Run observer flush on /new."
    },
    "enableHeartbeatObservation": {
      "label": "Observe On Heartbeat",
      "description": "Check observation thresholds during heartbeat events."
    },
    "enableCompactionObservation": {
      "label": "Observe On Compaction",
      "description": "Force observer flush during compaction events."
    },
    "enableWeeklyReflection": {
      "label": "Weekly Reflection",
      "description": "Run weekly reflection on Sunday midnight UTC."
    },
    "enableFactExtraction": {
      "label": "Fact Extraction",
      "description": "Extract structured facts from hook event payloads."
    },
    "autoCheckpoint": {
      "label": "Auto Checkpoint (Legacy Alias)",
      "description": "Deprecated alias for enableAutoCheckpoint."
    },
    "contextProfile": {
      "label": "Context Profile",
      "description": "Profile used for context injection at session start"
    },
    "maxContextResults": {
      "label": "Max Context Results",
      "description": "Number of vault memories to inject"
    },
    "enableBeforePromptRecall": {
      "label": "Enable Before Prompt Recall",
      "description": "Use before_prompt_build to force memory recall and inject vault context."
    },
    "enableMessageSendingFilter": {
      "label": "Enable Message Sending Filter",
      "description": "Use message_sending to rewrite or block protocol violations."
    },
    "enforceCommunicationProtocol": {
      "label": "Enforce Communication Protocol",
      "description": "Append protocol rules to system context and enforce banned-pattern rewrites."
    },
    "minQuestionRecallScore": {
      "label": "Min Question Recall Score",
      "description": "Score threshold when deciding if outbound questions are already answered by memory."
    },
    "observeOnHeartbeat": {
      "label": "Observe on Heartbeat (Legacy Alias)",
      "description": "Deprecated alias for enableHeartbeatObservation."
    },
    "weeklyReflection": {
      "label": "Weekly Reflection (Legacy Alias)",
      "description": "Deprecated alias for enableWeeklyReflection."
    }
  }
}