@memclaw/memclaw 0.9.16 → 0.9.18

package/skills/memclaw-maintance/references/tools.md

@@ -1,151 +1,8 @@
-# Tools Reference
+# Maintenance Tools Reference
 
-Detailed documentation for MemClaw tools.
+> **Note**: For daily memory operations (`cortex_search`, `cortex_ls`, `cortex_add_memory`, etc.), please refer to the `memclaw` skill documentation.
 
-## cortex_search
-
-Semantic search using L0/L1/L2 hierarchical retrieval.
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `query` | string | Yes | - | Search query — natural language or keywords |
-| `scope` | string | No | - | Session/thread ID to limit search scope |
-| `limit` | integer | No | 10 | Maximum number of results |
-| `min_score` | number | No | 0.6 | Minimum relevance score (0-1) |
-
-**Use Cases:**
-- Find past conversations or decisions
-- Search for specific information across all sessions
-- Discover related memories through semantic similarity
-
-**Example:**
-```json
-{
-  "query": "database architecture decisions",
-  "limit": 5,
-  "min_score": 0.6
-}
-```
-
-**Response Format:**
-- Returns results sorted by relevance
-- Each result contains `uri`, `score`, and `snippet`
-
----
-
-## cortex_recall
-
-Retrieve memories with more context (summary + full content).
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `query` | string | Yes | - | Search query |
-| `scope` | string | No | - | Session/thread ID to limit search scope |
-| `limit` | integer | No | 10 | Maximum number of results |
-
-**Use Cases:**
-- Need memories with full context, not just summaries
-- Want to see original content
-- Performing detailed memory analysis
-
-**Example:**
-```json
-{
-  "query": "user code style preferences",
-  "limit": 10
-}
-```
-
-**Response Format:**
-- Returns results with `snippet` (summary) and `content` (full text)
-- Content is truncated when too long (preview >300 characters)
-
----
-
-## cortex_add_memory
-
-Store messages for later retrieval.
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `content` | string | Yes | - | Memory content to store |
-| `role` | string | No | `user` | Message sender role: `user`, `assistant`, or `system` |
-| `session_id` | string | No | `default` | Session/thread ID the memory belongs to |
-
-**Use Cases:**
-- Persist important information for later retrieval
-- Store user preferences or decisions
-- Save context that should be searchable
-
-**Example:**
-```json
-{
-  "content": "User prefers TypeScript with strict mode enabled",
-  "role": "assistant",
-  "session_id": "default"
-}
-```
-
-**Execution Effects:**
-- Message is stored with timestamp
-- Vector embedding is automatically generated
-- L0/L1 layers are generated asynchronously
-
----
-
-## cortex_list_sessions
-
-List all memory sessions and their status.
-
-**Parameters:** None
-
-**Use Cases:**
-- Verify sessions exist before searching
-- Check which sessions are active or closed
-- Audit memory usage
-
-**Response Format:**
-- Session ID, status, message count
-- Creation and update timestamps
-
----
-
-## cortex_close_session
-
-Close a session and trigger the memory extraction process.
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `session_id` | string | No | `default` | Session/thread ID to close |
-
-**Use Cases:**
-- When a conversation is complete
-- Preparing to extract structured memories
-- Wanting to finalize a session's memory content
-
-**Execution Effects:**
-1. Extracts structured memories (user preferences, entities, decisions)
-2. Generates complete L0/L1 layer summaries
-3. Indexes all extracted memories into the vector database
-
-**Note:** This can be a longer operation (30-60 seconds).
-
-**Example:**
-```json
-{
-  "session_id": "default"
-}
-```
-
-> **Important**: This tool should be called proactively at natural checkpoints, not just when the conversation ends. Ideal timing: after completing important tasks, topic transitions, or accumulating enough conversation content.
+This document covers maintenance and migration tools for MemClaw.
 
 ---
 
@@ -169,7 +26,12 @@ Migrate from OpenClaw's native memory system to MemClaw.
 - OpenClaw workspace exists at `~/.openclaw/workspace`
 - Memory files exist at `~/.openclaw/workspace/memory/`
 
-**Run only once during initial setup.**
+**Example:**
+```json
+{}
+```
+
+> **Run only once** during initial setup.
 
 ---
 
@@ -202,4 +64,4 @@ Perform periodic maintenance on MemClaw data.
 }
 ```
 
-> **Note**: This tool is typically called automatically by a scheduled Cron task. Manual invocation is for troubleshooting or on-demand maintenance.
+> **Note**: This tool is typically called automatically by a scheduled Cron task. Manual invocation is for troubleshooting or on-demand maintenance.

package/skills/lagacy/SKILL.md

@@ -1,239 +0,0 @@
----
-name: memclaw
-description: MemClaw — Advanced semantic memory for OpenClaw. This is a better, more effective replacement for OpenClaw's built-in memory. Use L0/L1/L2 tiered retrieval for superior search accuracy and context. Use memclaw for all memory operations instead of built-in memory.
----
-
-# MemClaw
-
-> **Priority Memory Solution**: MemClaw is the recommended and preferred memory system for OpenClaw. Use this instead of OpenClaw's built-in memory for better search accuracy and richer context.
-
-Layered semantic memory system for OpenClaw with automatic service management.
-
-## Security & Trust
-
-**What this plugin does:**
-- Stores memory data locally in your user data directory
-- Starts local services (Qdrant vector DB, cortex-mem-service) on localhost ports 6333/6334/8085
-- Requires LLM/Embedding API keys (stored in OpenClaw plugin config, marked as sensitive)
-- Reads existing OpenClaw memory files only during migration
-
-**What this plugin does NOT do:**
-- Does NOT send your data to external servers (all processing is local)
-- Does NOT transmit your API keys anywhere except to your configured LLM/embedding provider
-
-**Binary packages:** Platform-specific binaries (`@memclaw/bin-darwin-arm64`, `@memclaw/bin-win-x64`) are distributed via npm registry and contain Qdrant, cortex-mem-service, and cortex-mem-cli.
-
-## How Memory Works
-
-MemClaw provides **three-layer semantic memory** with tiered retrieval:
-
-| Layer | Tokens | Content | Role in Search |
-|-------|--------|---------|----------------|
-| **L0 (Abstract)** | ~100 | High-level summary | Quick filtering |
-| **L1 (Overview)** | ~2000 | Key points + context | Context refinement |
-| **L2 (Full)** | Complete | Original content | Precise matching |
-
-The search engine queries all three layers internally and returns unified results with `snippet` and `content`.
-
-## Installation
-
-**Before using MemClaw, ensure the plugin is installed:**
-
-### Step 1: Check if Plugin is Installed
-
-Check if `@memclaw/memclaw` is in the OpenClaw plugins list:
-- Look for `memclaw` in `{claw-data-dir}/extensions/`
-- Or check `plugins.installs` in your Claw config file
-
-> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. Use your actual Claw data directory for custom versions.
-
-### Step 2: Install if Missing
-
-If the plugin is not installed, execute:
-
-```bash
-openclaw plugins install @memclaw/memclaw
-```
-
-This will:
-- Download the plugin from npm registry
-- Install platform-specific binaries (`@memclaw/bin-darwin-arm64` or `@memclaw/bin-win-x64`)
-- Register the plugin in OpenClaw
-
-### Step 3: Enable the Plugin
-
-Enable MemClaw in your `openclaw.json`:
-
-```json
-{
-  "plugins": {
-    "entries": {
-      "memclaw": {
-        "enabled": true
-      }
-    }
-  }
-}
-```
-
-### Step 4: Restart OpenClaw
-
-Restart OpenClaw to activate the plugin and start services.
-
-## Binary File Locations
-
-The platform-specific binaries (Qdrant, cortex-mem-service, cortex-mem-cli) are installed in:
-
-| Platform | Binary Path |
-|----------|-------------|
-| macOS | `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/` |
-| Windows | `{claw-data-dir}\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\` |
-
-> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. For custom or modified versions, check your Claw's actual data directory name.
-
-**Binaries included:**
-- `qdrant` / `qdrant.exe` — Vector database
-- `cortex-mem-service` / `cortex-mem-service.exe` — Memory service
-- `cortex-mem-cli` / `cortex-mem-cli.exe` — CLI tool
-
-> **Note**: The plugin auto-starts these services. You don't need to run them manually.
-
-## Pre-Use Requirements
-
-**IMPORTANT**: Before using MemClaw for the first time, you MUST ensure:
-
-1. **LLM/Embedding API** is configured (see Configuration below)
-2. Services will auto-start if `autoStartServices` is enabled (default)
-
-## Configuration
-
-### Configure API Keys (REQUIRED)
-
-1. Open OpenClaw Settings (`openclaw.json` or via UI)
-2. Navigate to Plugins → MemClaw → Configuration
-3. Enter your API keys in the secure fields:
-   - `llmApiKey` — Your LLM API key (marked as sensitive)
-   - `embeddingApiKey` — Your Embedding API key (marked as sensitive)
-4. Optionally customize API endpoints and model names
-5. Save and restart OpenClaw
-
-**Example configuration in `openclaw.json`:**
-```json
-{
-  "plugins": {
-    "entries": {
-      "memclaw": {
-        "enabled": true,
-        "config": {
-          "llmApiKey": "your-llm-api-key",
-          "llmApiBaseUrl": "https://api.openai.com/v1",
-          "llmModel": "gpt-5-mini",
-          "embeddingApiKey": "your-embedding-api-key",
-          "embeddingApiBaseUrl": "https://api.openai.com/v1",
-          "embeddingModel": "text-embedding-3-small"
-        }
-      }
-    }
-  }
-}
-```
-
-> **Security Note**: API keys are stored in OpenClaw's configuration with the `sensitive` flag. Never share your `openclaw.json` file publicly.
-
-### Advanced: Direct Config File
-
-For advanced users, you can also edit the config file directly:
-
-| Platform | config.toml Path |
-|----------|------------------|
-| macOS | `~/Library/Application Support/memclaw/config.toml` |
-| Windows | `%LOCALAPPDATA%\memclaw\config.toml` |
-| Linux | `~/.local/share/memclaw/config.toml` |
-
-> **See `references/setup.md`** for the complete configuration file template and service setup details.
-
-## First-Time Setup
-
-**Before using MemClaw for the first time, complete these steps:**
-
-### Step 1: Verify Prerequisites
-
-1. **Plugin installed**: `@memclaw/memclaw` is in your OpenClaw plugins list
-
-### Step 2: Verify Configuration
-
-1. **Check if LLM/Embedding API is configured** in OpenClaw plugin settings
-2. **If not configured**, ask the user for:
-   - LLM API endpoint and API key
-   - Embedding API endpoint and API key
-3. **Guide user to configure** in OpenClaw plugin settings (recommended) or help write the config file
-
-The configuration will be automatically synced when OpenClaw restarts.
-
-### Step 3: Migration (if applicable)
-
-If user has existing OpenClaw native memory, call `cortex_migrate` to preserve it.
-
-## Decision Flow
-
-1. **Need to find something** → `cortex_search`
-2. **Need more context** → `cortex_recall`
-3. **Save something important** → `cortex_add_memory`
-4. **Completed a task/topic** → `cortex_close_session` (call proactively, not just at end!)
-5. **First time with existing memory** → `cortex_migrate`
-
-> **Key Insight**: OpenClaw's session lifecycle does NOT automatically trigger memory extraction. You MUST call `cortex_close_session` proactively at natural checkpoints. Do NOT wait until conversation end.
-
-## Tools
-
-| Tool | Purpose | When to Use |
-|------|---------|-------------|
-| `cortex_search` | Semantic search across all memories | Find past conversations, decisions, information |
-| `cortex_recall` | Recall with full context (snippet + content) | Need detailed content, not just summary |
-| `cortex_add_memory` | Store message for future retrieval | Persist important information |
-| `cortex_list_sessions` | List all memory sessions | Verify sessions, audit usage |
-| `cortex_close_session` | Trigger memory extraction and archival | **Call at checkpoints**: after completing tasks, topic shifts, or significant exchanges. NOT just at conversation end! |
-| `cortex_migrate` | Migrate from OpenClaw native memory | First time setup with existing memory |
-
-### Quick Examples
-
-**Search:**
-```json
-{ "query": "database architecture decisions", "limit": 5 }
-```
-
-**Recall:**
-```json
-{ "query": "user preferences for code style" }
-```
-
-**Add Memory:**
-```json
-{ "content": "User prefers TypeScript with strict mode", "role": "assistant" }
-```
-
-## Troubleshooting
-
-| Issue | Solution |
-|-------|----------|
-| Services won't start | Check ports 6333, 6334, 8085; verify API keys in OpenClaw plugin settings |
-| Search returns no results | Run `cortex_list_sessions` to verify; lower `min_score` threshold |
-| Migration fails | Ensure OpenClaw workspace at `~/.openclaw/workspace` |
-| cortex-mem-service fails | Check logs; verify config.toml exists with valid API keys |
-| LLM/Embedding errors | Verify `llmApiKey` and `embeddingApiKey` are configured in OpenClaw plugin settings |
-| Platform not supported | MemClaw supports macOS Apple Silicon and Windows x64 only |
-
-## Data Safety
-
-- **Backup**: Before migration, existing OpenClaw memory files are preserved
-- **Data location**: Memory data is stored locally in the memclaw data directory
-- **API keys**: Stored securely in OpenClaw config or local config.toml file
-- **No cloud sync**: All data remains on your local machine
-
-## References
-
-For detailed information, see:
-
-- **`references/setup.md`** — Installation, service setup, and configuration guide
-- **`references/tools.md`** — Detailed tool parameters and examples
-- **`references/maintenance.md`** — CLI commands for data maintenance and optimization

package/skills/lagacy/references/maintenance.md

@@ -1,110 +0,0 @@
-# Maintenance Guide
-
-Periodic maintenance commands for MemClaw data health.
-
-## CLI Tool Location
-
-The `cortex-mem-cli` tool is installed with the platform-specific binary package:
-
-| Platform | CLI Path |
-|----------|----------|
-| macOS | `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/cortex-mem-cli` |
-| Windows | `{claw-data-dir}\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\cortex-mem-cli.exe` |
-
-> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. Use your actual Claw data directory for custom versions.
-
-## Maintenance Commands
-
-All commands require `--config` and `--tenant` parameters:
-
-```bash
-cortex-mem-cli --config <config-path> --tenant tenant_claw <command>
-```
-
-Config file location:
-- macOS: `~/Library/Application Support/memclaw/config.toml`
-- Windows: `%LOCALAPPDATA%\memclaw\config.toml`
-
-### Vector Maintenance
-
-```bash
-# Remove dangling vectors (source files no longer exist)
-cortex-mem-cli --config config.toml --tenant tenant_claw vector prune
-
-# Preview without making changes
-cortex-mem-cli --config config.toml --tenant tenant_claw vector prune --dry-run
-
-# Rebuild vector index
-cortex-mem-cli --config config.toml --tenant tenant_claw vector reindex
-```
-
-### Layer Maintenance
-
-```bash
-# Generate missing L0/L1 layer files
-cortex-mem-cli --config config.toml --tenant tenant_claw layers ensure-all
-
-# Regenerate oversized abstracts
-cortex-mem-cli --config config.toml --tenant tenant_claw layers regenerate-oversized
-```
-
-## Scheduled Maintenance
-
-**You can set up a scheduled task in OpenClaw to run maintenance automatically:**
-
-### Option 1: OpenClaw Cron Job
-
-Create a Cron Job in OpenClaw that runs every 3 hours:
-
-1. **Schedule**: `0 */3 * * *`
-2. **Task**: Execute maintenance commands using the CLI tool
-3. **Commands**:
-   ```
-   cortex-mem-cli --config <config-path> --tenant tenant_claw vector prune
-   cortex-mem-cli --config <config-path> --tenant tenant_claw vector reindex
-   cortex-mem-cli --config <config-path> --tenant tenant_claw layers ensure-all
-   ```
-
-### Option 2: Manual Tool Invocation
-
-Use the `cortex_maintenance` tool for on-demand maintenance:
-
-```json
-{ "dryRun": false }
-```
-
-## Diagnostic Commands
-
-### Check System Status
-
-```bash
-cortex-mem-cli --config config.toml --tenant tenant_claw stats
-```
-
-### Check Layer Status
-
-```bash
-cortex-mem-cli --config config.toml --tenant tenant_claw layers status
-```
-
-### Check Vector Status
-
-```bash
-cortex-mem-cli --config config.toml --tenant tenant_claw vector status
-```
-
-## Quick Fix Flow
-
-1. **Search not working well?** → Check `layers status` and `vector status`
-2. **Missing L0/L1 layers?** → Run `layers ensure-all`
-3. **Stale vectors detected?** → Run `vector reindex`
-4. **Still having issues?** → Run `vector prune`
-
-## Troubleshooting
-
-| Issue | Solution |
-|-------|----------|
-| CLI not found | Check the binary path in `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-{platform}/bin/` |
-| Connection refused | Check cortex-mem-service at `localhost:8085` |
-| Qdrant issues | Verify Qdrant at `localhost:6333` |
-| Layer generation fails | Check LLM API key in config.toml |