bereach-openclaw 0.2.9 → 0.2.11

package/README.md

@@ -8,6 +8,29 @@ LinkedIn outreach automation via [BeReach](https://berea.ch). Registers 33 in-pr
 openclaw plugins install bereach-openclaw
 ```
 
+## Upgrade
+
+`openclaw plugins update bereach` can leave `node_modules` and `extensions/` out of sync (version mismatch → trim/crash errors). **Use uninstall + reinstall** instead.
+
+**Before upgrading:** note your `BEREACH_API_KEY` — uninstall may remove `plugins.entries.bereach`.
+
+```bash
+# 1. Uninstall
+openclaw plugins uninstall bereach
+
+# 2. Reinstall latest
+openclaw plugins install bereach-openclaw
+
+# 3. Re-add config (API key + plugins.allow) in openclaw.json — see Setup above
+# 4. Restart the Gateway
+```
+
+Verify versions match:
+```bash
+cat /data/.openclaw/node_modules/bereach-openclaw/package.json | grep version
+cat /data/.openclaw/extensions/bereach/package.json | grep version
+```
+
 ## Setup
 
 The API key can be set in 3 ways (in order of precedence):
@@ -30,7 +53,27 @@ The API key can be set in 3 ways (in order of precedence):
 }
 ```
 
-> **Note:** Add `"bereach"` to `plugins.allow` — OpenClaw requires explicit allowlist for non-bundled plugins.
+> **Note:** `plugins.allow` loads the plugin. Tools are auto-enabled when the plugin is loaded (no `tools.allow` needed).
+
+**Skills + model (optional)** — `skills.entries` has no `model` field; model is set at the agent level. To use Sonnet for BeReach:
+
+```json
+{
+  "skills": {
+    "entries": {
+      "bereach": { "enabled": true }
+    }
+  },
+  "agents": {
+    "defaults": {
+      "model": { "primary": "anthropic/claude-sonnet-4-5" },
+      "models": {
+        "anthropic/claude-sonnet-4-5": { "alias": "sonnet" }
+      }
+    }
+  }
+}
+```
 
 **2. Environment variable** — `BEREACH_API_KEY=brc_xxx` in your shell or `export BEREACH_API_KEY="brc_xxx"` in `~/.bashrc`.
 
@@ -38,6 +81,57 @@ The API key can be set in 3 ways (in order of precedence):
 
 Restart the Gateway after configuring.
 
+## Troubleshooting
+
+### BeReach tools (`bereach_*`) not visible in my session
+
+The plugin is loaded but tools don't appear in the agent's tool list. Common causes:
+
+1. **Plugin installed after session started** — Existing sessions don't pick up new tools.
+2. **Gateway not restarted** — Config changes require a restart.
+
+**Fix:**
+```bash
+openclaw gateway restart
+# Then start a NEW session (e.g. new Telegram chat)
+# Test: "Utilise bereach_get_credits"
+```
+
+### "Cannot read properties of undefined (reading 'trim')" or "plugin disabled (not in allowlist)"
+
+OpenClaw loads plugins from **two locations**:
+- `node_modules/bereach-openclaw/` — the npm package (source)
+- `extensions/bereach/` — the active copy OpenClaw uses at runtime
+
+If `extensions/bereach/` is corrupt or incomplete, you get trim/undefined errors. Fix:
+
+**1. Backup and remove the active extension:**
+```bash
+mv /data/.openclaw/extensions/bereach /data/.openclaw/extensions/bereach.bak.$(date +%s)
+```
+
+**2. Reinstall from npm (inside the container):**
+```bash
+cd /data/.openclaw
+npm i bereach-openclaw@latest
+```
+
+**3. Restart OpenClaw** so it rebuilds `extensions/bereach/` from the package.
+
+**4. If `extensions/bereach/` is still incomplete after restart**, force a symlink:
+```bash
+rm -rf /data/.openclaw/extensions/bereach
+ln -s /data/.openclaw/node_modules/bereach-openclaw /data/.openclaw/extensions/bereach
+# then restart the container
+```
+
+**5. Verify** — compare the two manifests:
+```bash
+wc -l /data/.openclaw/extensions/bereach/openclaw.plugin.json
+wc -l /data/.openclaw/node_modules/bereach-openclaw/openclaw.plugin.json
+```
+They should match. Per [OpenClaw Plugin Manifest](https://docs.openclaw.ai/plugins/manifest), tools are registered at runtime via `api.registerTool()`.
+
 ## Usage
 
 ### Tools (33 registered)

package/openclaw.plugin.json

@@ -1,10 +1,13 @@
 {
   "id": "bereach",
   "name": "BeReach",
+  "version": "0.2.11",
   "description": "LinkedIn outreach automation — 33 tools, auto-reply commands, campaign monitoring",
   "configSchema": {
     "type": "object",
-    "required": ["BEREACH_API_KEY"],
+    "required": [
+      "BEREACH_API_KEY"
+    ],
     "additionalProperties": false,
     "properties": {
       "BEREACH_API_KEY": {
@@ -20,5 +23,8 @@
       "sensitive": true,
       "placeholder": "brc_..."
     }
-  }
+  },
+  "skills": [
+    "skills/bereach"
+  ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bereach-openclaw",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "BeReach LinkedIn automation plugin for OpenClaw",
   "license": "AGPL-3.0",
   "scripts": {

package/src/tools/index.ts

@@ -3,23 +3,23 @@ import { definitions } from "./definitions";
 
 /**
  * Registers all 33 BeReach tools with the OpenClaw agent.
- * Each tool delegates to the corresponding SDK method via dot-path resolution.
- * Client is created lazily on first tool invocation to avoid trim/undefined errors during plugin load.
+ * Format per https://docs.openclaw.ai/plugins/agent-tools
+ * Tools are required (not optional) — auto-enabled when plugin is loaded. Simpler UX: no tools.allow needed.
  */
 export function registerAllTools(api: any) {
   for (const def of definitions) {
-    api.registerTool(
-      def.name,
-      {
-        description: def.description,
-        parameters: def.parameters,
-      },
-      async (params: Record<string, unknown>) => {
+    api.registerTool({
+      name: def.name,
+      description: def.description,
+      parameters: def.parameters,
+      async execute(_id: string, params: Record<string, unknown>) {
         const client = getClient();
         const [resource, method] = def.handler.split(".");
         const result = await (client as any)[resource][method](params);
-        return result;
+        return {
+          content: [{ type: "text" as const, text: JSON.stringify(result, null, 2) }],
+        };
       },
-    );
+    });
   }
 }