@lacneu/openclaw-knowledge 3.1.0

package/openclaw.plugin.json

@@ -0,0 +1,149 @@
+{
+  "id": "openclaw-knowledge",
+  "name": "Knowledge Base",
+  "description": "Multi-source knowledge search (pgvector + LightRAG) — injects relevant documents and knowledge graph context before each turn via the before_prompt_build hook",
+  "version": "3.1.0",
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "enabled": {
+        "type": "boolean",
+        "default": true,
+        "description": "Master switch — disables all knowledge injection when false"
+      },
+      "geminiApiKey": {
+        "type": "string",
+        "description": "Gemini API key used to embed user queries for pgvector search. Supports ${ENV_VAR} substitution."
+      },
+      "postgresUrl": {
+        "type": "string",
+        "description": "PostgreSQL connection string for the knowledge database (pgvector). Supports ${ENV_VAR} substitution."
+      },
+      "collections": {
+        "type": "array",
+        "items": { "type": "string" },
+        "default": ["knowledge_default"],
+        "description": "Collection names to search in the knowledge_vectors table"
+      },
+      "topK": {
+        "type": "number",
+        "minimum": 1,
+        "maximum": 100,
+        "default": 5,
+        "description": "Maximum number of results returned per collection"
+      },
+      "scoreThreshold": {
+        "type": "number",
+        "minimum": 0,
+        "maximum": 1,
+        "default": 0.3,
+        "description": "Minimum cosine similarity score (0–1) to include a result"
+      },
+      "maxInjectChars": {
+        "type": "number",
+        "minimum": 0,
+        "default": 4000,
+        "description": "Character budget for pgvector results injected into the prompt"
+      },
+      "pgvectorEnabled": {
+        "type": "boolean",
+        "description": "Disable pgvector search while keeping LightRAG. Defaults to true when geminiApiKey is set."
+      },
+      "lightragUrl": {
+        "type": "string",
+        "description": "LightRAG server base URL (e.g. http://openclaw-lightrag:9621). Supports ${ENV_VAR} substitution."
+      },
+      "lightragApiKey": {
+        "type": "string",
+        "description": "LightRAG API key sent as X-API-Key header. Supports ${ENV_VAR} substitution."
+      },
+      "lightragQueryMode": {
+        "type": "string",
+        "enum": ["naive", "local", "global", "hybrid"],
+        "default": "hybrid",
+        "description": "LightRAG query mode: naive (vector), local (entity), global (community), hybrid (recommended)"
+      },
+      "lightragMaxChars": {
+        "type": "number",
+        "minimum": 0,
+        "default": 4000,
+        "description": "Character budget for LightRAG context injected into the prompt"
+      },
+      "lightragEnabled": {
+        "type": "boolean",
+        "description": "Disable LightRAG search while keeping pgvector. Defaults to true when lightragUrl is set."
+      }
+    },
+    "required": []
+  },
+  "uiHints": {
+    "enabled": {
+      "label": "Auto-inject knowledge",
+      "help": "Automatically search and inject relevant documents before each agent turn"
+    },
+    "geminiApiKey": {
+      "label": "Gemini API Key",
+      "placeholder": "${GEMINI_API_KEY}",
+      "sensitive": true,
+      "help": "Required for pgvector search. Use ${GEMINI_API_KEY} for env var substitution."
+    },
+    "postgresUrl": {
+      "label": "PostgreSQL URL",
+      "placeholder": "postgresql://openclaw:${POSTGRES_PASSWORD}@postgresql:5432/knowledge",
+      "sensitive": true,
+      "help": "Connection string for the knowledge database. Supports ${ENV_VAR} substitution."
+    },
+    "collections": {
+      "label": "Collections to search",
+      "placeholder": "knowledge_default",
+      "help": "Collection names in the knowledge_vectors table (e.g. knowledge_olivier, knowledge_shared)"
+    },
+    "topK": {
+      "label": "Top-K per collection",
+      "advanced": true,
+      "help": "Maximum number of results returned per collection (default: 5)"
+    },
+    "scoreThreshold": {
+      "label": "Score threshold",
+      "advanced": true,
+      "help": "Minimum cosine similarity 0–1 to include a result (default: 0.3)"
+    },
+    "maxInjectChars": {
+      "label": "Max pgvector chars",
+      "advanced": true,
+      "help": "Character budget for pgvector results (default: 4000)"
+    },
+    "pgvectorEnabled": {
+      "label": "Enable pgvector source",
+      "advanced": true,
+      "help": "Disable pgvector while keeping LightRAG. Defaults to true when geminiApiKey is set."
+    },
+    "lightragUrl": {
+      "label": "LightRAG URL",
+      "placeholder": "http://openclaw-lightrag:9621",
+      "help": "LightRAG server base URL"
+    },
+    "lightragApiKey": {
+      "label": "LightRAG API Key",
+      "placeholder": "${LIGHTRAG_API_KEY}",
+      "sensitive": true,
+      "help": "Sent as X-API-Key header. Use ${LIGHTRAG_API_KEY} for env var substitution."
+    },
+    "lightragQueryMode": {
+      "label": "LightRAG Query Mode",
+      "advanced": true,
+      "help": "naive (vector), local (entity), global (community), hybrid (recommended)"
+    },
+    "lightragMaxChars": {
+      "label": "Max LightRAG chars",
+      "advanced": true,
+      "help": "Character budget for LightRAG context (default: 4000)"
+    },
+    "lightragEnabled": {
+      "label": "Enable LightRAG source",
+      "advanced": true,
+      "help": "Disable LightRAG while keeping pgvector. Defaults to true when lightragUrl is set."
+    }
+  }
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@lacneu/openclaw-knowledge",
+  "version": "3.1.0",
+  "type": "module",
+  "description": "Multi-source knowledge plugin for OpenClaw — pgvector + LightRAG injection via before_prompt_build hook",
+  "license": "MIT",
+  "author": "Olivier Neu",
+  "homepage": "https://github.com/OlivierNeu/openclaw-knowledge-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OlivierNeu/openclaw-knowledge-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/OlivierNeu/openclaw-knowledge-plugin/issues"
+  },
+  "keywords": [
+    "openclaw",
+    "openclaw-plugin",
+    "rag",
+    "pgvector",
+    "lightrag",
+    "knowledge-graph",
+    "gemini",
+    "embeddings"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "openclaw.plugin.json",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "build:test": "tsc -p tsconfig.test-build.json",
+    "clean": "rm -rf dist dist-test",
+    "typecheck": "tsc -p tsconfig.test.json",
+    "test": "npm run build:test && node --test dist-test/test/*.test.js",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "openclaw": {
+    "extensions": ["./dist/index.js"],
+    "compat": {
+      "pluginApi": ">=2026.3.7",
+      "minGatewayVersion": "2026.3.7"
+    }
+  },
+  "dependencies": {
+    "pg": "^8.13.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/pg": "^8.11.0",
+    "openclaw": ">=2026.3.7",
+    "typescript": "^5.6.0"
+  },
+  "peerDependencies": {
+    "openclaw": ">=2026.3.7"
+  },
+  "peerDependenciesMeta": {
+    "openclaw": {
+      "optional": true
+    }
+  }
+}