Skip to content

README.md

Latest commit

 

History

History
98 lines (75 loc) · 3.21 KB

README.md

File metadata and controls

98 lines (75 loc) · 3.21 KB
Raw

@tpsdev-ai/openclaw-flair

OpenClaw memory plugin for Flair — agent identity and semantic memory. Replaces the built-in MEMORY.md / memory-lancedb system with Flair as the single source of truth for agent memory.

Uses Flair's native Harper vector embeddings — no OpenAI API key required.

Features

  • Semantic search via memory_search → Flair's HNSW vector index
  • Persistent storage via memory_store → Ed25519-authenticated writes
  • Memory retrieval via memory_get → fetch by ID
  • Auto-bootstrap — injects relevant memories into context at session start
  • Auto-capture — automatically stores important information from conversations
  • Multi-agent — agentId: "auto" resolves per-session for shared gateways
  • Durability levels — permanent, persistent, standard, ephemeral
  • Memory versioning — supersedes field creates version chains

Prerequisites

  • A running Flair instance (Harper v5+)
  • An agent record in Flair with an Ed25519 public key
  • The corresponding private key at ~/.flair/keys/<agentId>.key (generated by flair agent add)

Installation

# From npm (when published)
openclaw plugin install @tpsdev-ai/openclaw-flair

# From source
cd plugins/openclaw-memory
npm install

Configuration

In your OpenClaw config (openclaw.json):

{
  "plugins": {
    "allow": ["memory-flair"],
    "slots": {
      "memory": "memory-flair"
    },
    "entries": {
      "memory-flair": {
        "enabled": true,
        "config": {
          "url": "http://localhost:19926",
          "agentId": "auto",
          "autoCapture": true,
          "autoRecall": true,
          "maxRecallResults": 5,
          "maxBootstrapTokens": 4000
        }
      }
    }
  }
}

Config Options

Option Type Default Description
url string http://127.0.0.1:19926 Flair server URL
agentId string required Agent ID for memory namespacing. Use "auto" for multi-agent gateways.
keyPath string auto-resolved Path to Ed25519 private key
autoCapture boolean true Auto-capture important info from conversations
autoRecall boolean true Inject relevant memories at session start
maxRecallResults number 5 Max results for memory_search

Tool naming

OpenClaw's coding profile allows memory_search and memory_get by canonical name. memory_store is not a core tool name, so it's filtered out by the default profile. To surface it to the LLM, add it to your openclaw.json:

"tools": {
  "profile": "coding",
  "alsoAllow": ["memory_store"]
}

| maxBootstrapTokens | number | 4000 | Max tokens for bootstrap context injection |

Auth

Uses Ed25519 signatures. The plugin looks for private keys in this order:

  1. keyPath from config (if explicitly set)
  2. $FLAIR_KEY_DIR/<agentId>.key (if FLAIR_KEY_DIR env var is set)
  3. ~/.flair/keys/<agentId>.key (standard path — use flair agent add to generate)

Key files may be raw 32-byte binary seeds (written by flair agent add) or base64-encoded seeds. Both are supported.

License

Apache-2.0