@memclaw/memclaw 0.9.16 → 0.9.18

package/skills/lagacy/references/setup.md

@@ -1,283 +0,0 @@
-# Setup Guide
-
-Installation and configuration guide for MemClaw.
-
-## Supported Platforms
-
-| Platform | npm Package |
-|----------|-------------|
-| macOS Apple Silicon | `@memclaw/bin-darwin-arm64` |
-| Windows x64 | `@memclaw/bin-win-x64` |
-
-> **Note**: MemClaw is only supported on the platforms listed above.
-
-## Requirements
-
-| Requirement | Details |
-|-------------|---------|
-| **Node.js** | ≥ 20.0.0 |
-| **OpenClaw** | Installed and configured |
-| **Qdrant** | Vector database (port 6333/6334) |
-| **cortex-mem-service** | Memory service (port 8085) |
-
-## Binary Installation
-
-MemClaw binaries (Qdrant, cortex-mem-service, cortex-mem-cli) are distributed via platform-specific npm packages:
-
-- `@memclaw/bin-darwin-arm64` — macOS Apple Silicon
-- `@memclaw/bin-win-x64` — Windows x64
-
-These packages are installed automatically as optional dependencies when installing `@memclaw/memclaw`.
-
-### Binary Locations After Installation
-
-When installed via OpenClaw (`openclaw plugins install @memclaw/memclaw`), binaries are located at:
-
-| Platform | 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 Claw versions, replace with your actual Claw data directory (e.g., `~/.claw`, `~/.myclaw`, etc.).
-
-**Binaries included:**
-- `qdrant` (or `qdrant.exe`) — Vector database server
-- `cortex-mem-service` (or `cortex-mem-service.exe`) — Memory extraction service
-- `cortex-mem-cli` (or `cortex-mem-cli.exe`) — Command-line maintenance tool
-
-### Verify Binary Installation
-
-Check if binaries exist:
-
-```bash
-# macOS (adjust claw-data-dir as needed)
-ls ~/.openclaw/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/
-
-# Windows (adjust claw-data-dir as needed)
-dir %USERPROFILE%\.openclaw\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\
-```
-
-### Manual Binary Installation
-
-If binaries are not installed, run:
-
-```
-npm install @memclaw/bin-darwin-arm64
-or
-bun install @memclaw/bin-darwin-arm64
-```
-
-or (for Windows):
-
-```
-npm install @memclaw/bin-win-x64
-or
-bun install @memclaw/bin-win-x64
-```
-
-## First-Time Setup Checklist
-
-**Before using MemClaw, complete these steps:**
-
-### Step 1: Verify Platform Support
-
-Ensure you are on a supported platform (macOS Apple Silicon or Windows x86/x64).
-
-### Step 2: Create Data Directory
-
-Create the data directory if it does not exist:
-
-| Platform | Command |
-|----------|---------|
-| macOS | `mkdir -p ~/Library/Application\ Support/memclaw` |
-| Windows | `mkdir %LOCALAPPDATA%\memclaw` |
-| Linux | `mkdir -p ~/.local/share/memclaw` |
-
-### Step 3: Ask User for Configuration
-
-**Agent MUST ask the user for the following information:**
-
-1. **LLM Configuration**:
-   - API endpoint URL (OpenAI-compatible)
-   - API key
-
-2. **Embedding Configuration**:
-   - API endpoint URL (OpenAI-compatible)
-   - API key
-   - Model name (default: `text-embedding-3-small`)
-
-### Step 4: Write Configuration File
-
-Write `config.toml` to the data directory with all required sections:
-
-| Platform | config.toml Path |
-|----------|------------------|
-| macOS | `~/Library/Application Support/memclaw/config.toml` |
-| Windows | `%LOCALAPPDATA%\memclaw\config.toml` |
-| Linux | `~/.local/share/memclaw/config.toml` |
-
-**Full configuration template:**
-
-```toml
-# Qdrant Vector Database Configuration
-[qdrant]
-url = "http://localhost:6334"
-collection_name = "memclaw"
-timeout_secs = 30
-
-# LLM Configuration [REQUIRED]
-[llm]
-api_base_url = "https://your-llm-provider.com/v1"
-api_key = "your-api-key-here"
-model_efficient = "gpt-5-mini"
-temperature = 0.1
-max_tokens = 65536
-
-# Embedding Configuration [REQUIRED]
-[embedding]
-api_base_url = "https://your-embedding-provider.com/v1"
-api_key = "your-api-key-here"
-model_name = "text-embedding-3-small"
-batch_size = 10
-timeout_secs = 30
-
-# Service Configuration
-[server]
-host = "localhost"
-port = 8085
-
-# Logging Configuration
-[logging]
-enabled = false
-log_directory = "logs"
-level = "info"
-
-# Cortex Memory Settings
-[cortex]
-enable_intent_analysis = false
-```
-
-> **CRITICAL**: All sections are required. If any section is missing, cortex-mem-service will silently fall back to environment variables and the configuration will be ignored.
-
-### Step 5: Verify Services
-
-Check that Qdrant and cortex-mem-service are accessible:
-
-| Service | Port | Health Check |
-|---------|------|--------------|
-| Qdrant | 6333 (HTTP), 6334 (gRPC) | HTTP GET to `http://localhost:6333` should return Qdrant version info |
-| cortex-mem-service | 8085 | HTTP GET to `http://localhost:8085/health` should return `{"status":"ok"}` |
-
-### Step 6: Start Services (if not running)
-
-**Starting Qdrant:**
-
-If `autoStartServices` is `true` in plugin config, MemClaw will start Qdrant automatically.
-
-To start manually, run the Qdrant binary from the platform package with:
-- `--storage-path` pointing to a storage directory
-- `--http-port 6333`
-- `--grpc-port 6334`
-
-**Starting cortex-mem-service:**
-
-**CRITICAL**: cortex-mem-service MUST be started with `--data-dir` flag pointing to the directory containing `config.toml`.
-
-Arguments:
-- `--data-dir <path>` — Path to data directory containing `config.toml` (**REQUIRED**)
-
-Example:
-```
-cortex-mem-service --data-dir ~/Library/Application\ Support/memclaw
-```
-
-Or on Windows:
-```
-cortex-mem-service --data-dir %LOCALAPPDATA%\memclaw
-```
-
-## Plugin Configuration
-
-Edit your `openclaw.json`:
-
-```json
-{
-  "plugins": {
-    "entries": {
-      "memclaw": {
-        "enabled": true,
-        "config": {
-          "serviceUrl": "http://localhost:8085",
-          "tenantId": "tenant_claw",
-          "autoStartServices": true
-        }
-      }
-    }
-  },
-  "agents": {
-    "defaults": {
-      "memorySearch": { "enabled": false }
-    }
-  }
-}
-```
-
-> **Important**: Set `memorySearch.enabled: false` to disable OpenClaw's built-in memory search and use MemClaw instead.
-
-### Configuration Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `serviceUrl` | string | `http://localhost:8085` | Cortex Memory service URL |
-| `tenantId` | string | `tenant_claw` | Tenant ID for data isolation |
-| `autoStartServices` | boolean | `true` | Auto-start Qdrant and cortex-mem-service |
-| `defaultSessionId` | string | `default` | Default session for memory operations |
-| `searchLimit` | number | `10` | Default number of search results |
-| `minScore` | number | `0.6` | Minimum relevance score (0-1) |
-
-## Troubleshooting
-
-### Platform Not Supported
-
-If you see "Platform not supported" error:
-- Verify you are on macOS Apple Silicon or Windows x64
-- Check that the correct `@memclaw/bin-*` package is installed
-
-### Binaries Not Found
-
-If binaries are missing:
-1. Verify `@memclaw/bin-*` package is in `node_modules`
-2. Try npm/bun reinstalling: `npm install @memclaw/bin-darwin-arm64` (or `bin-win-x64`)
-
-### cortex-mem-service Won't Start
-
-1. Verify `--data-dir` flag is provided
-2. Verify `config.toml` exists in the data directory
-3. Verify required fields in `config.toml`:
-   - `llm.api_key` is non-empty
-   - `embedding.api_key` is non-empty
-
-Default data directories:
-| Platform | Path |
-|----------|------|
-| macOS | `~/Library/Application Support/memclaw` |
-| Windows | `%LOCALAPPDATA%\memclaw` |
-| Linux | `~/.local/share/memclaw` |
-
-### Services Not Accessible
-
-1. Verify ports 6333, 6334, 8085 are not in use by other applications
-2. Verify firewall allows connections on these ports
-3. Check service logs for error messages
-
-### Configuration File Issues
-
-1. Ensure `config.toml` uses valid TOML syntax
-2. Verify file encoding is UTF-8
-3. On Windows, use double backslashes in paths: `C:\\Users\\...`
-
-### API Key Issues
-
-1. Verify API key is valid and has sufficient credits
-2. Verify `api_base_url` is correct for your provider
-3. Verify network connectivity to the API endpoint

package/skills/lagacy/references/tools.md

@@ -1,170 +0,0 @@
-# Tools Reference
-
-Detailed documentation for MemClaw tools.
-
-## cortex_search
-
-Semantic search across all memories using L0/L1/L2 tiered retrieval.
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `query` | string | Yes | - | The 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) |
-
-**When to use:**
-- Find past conversations or decisions
-- Search for specific information across all sessions
-- Discover related memories by semantic similarity
-
-**Example:**
-```json
-{
-  "query": "database architecture decisions",
-  "limit": 5,
-  "min_score": 0.6
-}
-```
-
-**Response format:**
-- Returns ranked results with relevance scores
-- Each result includes `uri`, `score`, and `snippet`
-
----
-
-## cortex_recall
-
-Recall memories with more context (snippet + full content).
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `query` | string | Yes | - | The search query |
-| `scope` | string | No | - | Session/thread ID to limit search scope |
-| `limit` | integer | No | 10 | Maximum number of results |
-
-**When to use:**
-- Need memories with full context, not just summaries
-- Want to see the original content, not just snippets
-- Conducting detailed memory analysis
-
-**Example:**
-```json
-{
-  "query": "user preferences for code style",
-  "limit": 10
-}
-```
-
-**Response format:**
-- Returns results with both `snippet` (summary) and `content` (full text)
-- Content is truncated if very long (>300 chars preview)
-
----
-
-## cortex_add_memory
-
-Store a message for future retrieval.
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `content` | string | Yes | - | The content to store in memory |
-| `role` | string | No | `user` | Role of the message sender: `user`, `assistant`, or `system` |
-| `session_id` | string | No | `default` | Session/thread ID for the memory |
-
-**When to use:**
-- Persist important information for future retrieval
-- Store user preferences or decisions
-- Save context that should be searchable later
-
-**Example:**
-```json
-{
-  "content": "User prefers TypeScript with strict mode enabled and explicit return types",
-  "role": "assistant",
-  "session_id": "default"
-}
-```
-
-**What happens:**
-- Message is stored with timestamp
-- Vector embedding is generated automatically
-- L0/L1 layers are generated asynchronously
-
----
-
-## cortex_list_sessions
-
-List all memory sessions with their status.
-
-**Parameters:** None
-
-**When to use:**
-- Verify sessions exist before searching
-- Check which sessions are active or closed
-- Audit memory usage
-
-**Response format:**
-- Session IDs, status, message counts
-- Creation and update timestamps
-
----
-
-## cortex_close_session
-
-Close a session and trigger memory extraction pipeline.
-
-**Parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `session_id` | string | No | `default` | Session/thread ID to close |
-
-**When to use:**
-- Conversation is complete
-- Ready to extract structured memories
-- Want to finalize the session's memory content
-
-**What happens:**
-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 is a potentially long-running operation (30-60 seconds).
-
-**Example:**
-```json
-{
-  "session_id": "default"
-}
-```
-
----
-
-## cortex_migrate
-
-Migrate memories from OpenClaw's native memory system to MemClaw.
-
-**Parameters:** None
-
-**When to use:**
-- First time setup with existing OpenClaw memory
-- Want to preserve previous conversation history
-- Switching from built-in memory to MemClaw
-
-**What happens:**
-1. Finds OpenClaw memory files (`memory/*.md` and `MEMORY.md`)
-2. Converts them to MemClaw's L2 format
-3. Generates L0/L1 layers and vector index
-
-**Prerequisites:**
-- OpenClaw workspace exists at `~/.openclaw/workspace`
-- Memory files exist in `~/.openclaw/workspace/memory/`
-
-**Run only once during initial setup.**