bereach-openclaw 1.5.3 → 1.5.5

package/node_modules/@bereach/tools/src/definitions.ts

@@ -2055,4 +2055,23 @@ export const definitions: ToolDefinition[] = [
       properties: {},
     },
   },
+
+  // ── API Key Setup ────────────────────────────────────────────────
+
+  {
+    name: "bereach_set_api_key",
+    description: "Save the BeReach API key in plugin configuration. Call this when the user provides their API key (starts with brc_). After saving, tell the user to restart the gateway with 'openclaw gateway restart' and start a new chat with /new.",
+    handler: "__set_api_key__",
+    parameters: {
+      type: "object",
+      required: ["apiKey"],
+      properties: {
+        apiKey: {
+          type: "string",
+          description: "The BeReach API key (must start with brc_)",
+        },
+      },
+      additionalProperties: false,
+    },
+  },
 ];

package/openclaw.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "bereach-openclaw",
   "name": "BeReach",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "LinkedIn outreach automation — 75+ tools, hook-based enforcement, dynamic context",
   "configSchema": {
     "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bereach-openclaw",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "BeReach LinkedIn automation plugin for OpenClaw",
   "license": "AGPL-3.0",
   "exports": {

package/skills/bereach/SKILL.md

@@ -1,7 +1,7 @@
 ---
 name: bereach
 description: "Automate LinkedIn outreach via BeReach (bereach.ai). Use when: prospecting, engaging posts, scraping engagement, searching LinkedIn, managing inbox, running campaigns, managing invitations, analytics, company pages, Sales Navigator, content engagement, feed monitoring. Requires BEREACH_API_KEY."
-lastUpdatedAt: 1775561761
+lastUpdatedAt: 1775565279
 metadata: { "openclaw": { "requires": { "env": ["BEREACH_API_KEY"] }, "primaryEnv": "BEREACH_API_KEY" } }
 ---
 
@@ -45,13 +45,13 @@ At install or upgrade, set up the workspace with these templates:
 
 When the user provides their BeReach API key (`brc_...`):
 
-1. Tell them to paste this command in chat: `/bereach-set-key brc_THEIR_KEY` (replacing with their actual key)
+1. Call the `bereach_set_api_key` tool with their key
 2. Tell them to restart the gateway: `openclaw gateway restart`
 3. After restart, start a new chat with `/new`
 
 If the user doesn't have a key, direct them to https://bereach.ai/token
 
-**Never** try to set the key via environment variables, auth profiles, or manual config edits. Always use `/bereach-set-key`.
+**Never** use config.patch, environment variables, or manual config edits. Always use the `bereach_set_api_key` tool.
 
 ## Two Modes of Operation
 

package/src/hooks/context.ts

@@ -374,7 +374,7 @@ function formatCampaignDispatch(
   const shown = Math.min(ranked.length, 7);
   for (let i = 0; i < shown; i++) {
     const { campaign: c } = ranked[i];
-    const pipelineUrl = `${CHAT_BASE}/pipeline?campaign=${c.id}`;
+    const pipelineUrl = `${CHAT_BASE}/campaigns/${c.id}/pipeline`;
     const s = c.stageCounts;
     const funnel = s && (s.lead || s.qualified || s.approved || s.rejected)
       ? ` — ${s.lead ?? 0}L / ${s.qualified ?? 0}Q / ${s.approved ?? 0}A / ${s.rejected ?? 0}R`
@@ -479,7 +479,7 @@ function formatOnboardingDirective(state: SessionState, data: CacheStore, apiKey
       "",
       "Search 5 matching prospects, visit top 3. Present: name, title, company, why they fit, suggested approach.",
       "Offer first action: connect, warm up (like/comment), or save to campaign.",
-      "Execute, then link: [Pipeline](${CHAT_BASE}/pipeline) / [Campaigns](${CHAT_BASE}/campaigns)",
+      "Execute, then link: [Campaigns](${CHAT_BASE}/campaigns)",
       '- `bereach_state_patch({ key: "onboarding", data: { quickWinDone: true } })`',
       "",
     );
@@ -576,7 +576,7 @@ function formatLiveStatus(state: SessionState, data: CacheStore, apiKey?: string
       lines.push("");
     }
     lines.push("### Dashboard Links");
-    lines.push(`[Pipeline](${CHAT_BASE}/pipeline) | [Campaigns](${CHAT_BASE}/campaigns) | [Drafts](${CHAT_BASE}/drafts) | [Context](${CHAT_BASE}/context) | [Settings](${CHAT_BASE}/settings) | [Pricing](${PRICING_URL})`);
+    lines.push(`[Campaigns](${CHAT_BASE}/campaigns) | [Activity](${CHAT_BASE}/activity) | [Context](${CHAT_BASE}/context) | [Settings](${CHAT_BASE}/settings) | [Pricing](${PRICING_URL})`);
     lines.push("");
     log(`live-status: ONBOARDING mode (${lines.join("\n").length} chars)`);
     return lines.join("\n");
@@ -733,7 +733,7 @@ function formatLiveStatus(state: SessionState, data: CacheStore, apiKey?: string
   if (upgradeBlock) lines.push(upgradeBlock);
 
   // Dashboard links
-  lines.push(`**Links**: [Pipeline](${CHAT_BASE}/pipeline) | [Campaigns](${CHAT_BASE}/campaigns) | [Drafts](${CHAT_BASE}/drafts) | [Context](${CHAT_BASE}/context) | [Settings](${CHAT_BASE}/settings) | [Pricing](${PRICING_URL})`);
+  lines.push(`**Links**: [Campaigns](${CHAT_BASE}/campaigns) | [Activity](${CHAT_BASE}/activity) | [Context](${CHAT_BASE}/context) | [Settings](${CHAT_BASE}/settings) | [Pricing](${PRICING_URL})`);
   lines.push("");
 
   log(`live-status: ACTIVE mode, campaigns=${hasCampaigns} contacts=${hasContacts} pending=${data.pendingDrafts > 0 || data.failedDrafts > 0 || data.unreadDMs > 0} (${lines.join("\n").length} chars)`);
@@ -1015,16 +1015,16 @@ export function registerContextHook(api: any, apiKey: string | undefined, state:
             "IMPORTANT: BeReach plugin is installed but no API key is configured.",
             "",
             "If the user provides their BeReach API key (a string starting with brc_):",
-            "- Tell them to paste this command in chat: /bereach-set-key brc_THEIR_KEY",
-            "- Then restart the gateway: openclaw gateway restart",
+            "- Call the bereach_set_api_key tool with their key",
+            "- Then tell them to restart the gateway: openclaw gateway restart",
             "- Then start a new chat: /new",
             "",
             "If the user has NOT provided a key yet:",
             "- Ask them for their BeReach API key",
             "- They can get one at https://bereach.ai/token",
             "",
-            "The /bereach-set-key command saves the key securely in the plugin config.",
-            "Do NOT suggest environment variables, config.patch, or any other method.",
+            "ALWAYS use the bereach_set_api_key tool to save the key.",
+            "Do NOT use config.patch, environment variables, or any other method.",
           ].join("\n") };
         }
 

package/src/hooks/enforcement.ts

@@ -592,11 +592,14 @@ export function registerEnforcementHook(
     const toolName: string = ctx?.toolName ?? ctx?.name ?? "";
     if (!toolName.startsWith("bereach_")) return;
 
+    // Allow set_api_key and self_upgrade without an API key
+    if (toolName === "bereach_set_api_key" || toolName === "bereach_self_upgrade") return;
+
     // Resolve API key dynamically
     const resolvedKey = api?.pluginConfig?.BEREACH_API_KEY ?? api?.pluginConfig?.apiKey ?? apiKey;
     const key = typeof resolvedKey === "string" && resolvedKey.trim() ? resolvedKey.trim() : undefined;
     if (!key) {
-      return { block: true, blockReason: "BLOCKED: BeReach API key not configured. Set it via /bereach-setup or plugin settings, then restart the gateway." };
+      return { block: true, blockReason: "BLOCKED: BeReach API key not configured. Provide your key so the agent can save it with bereach_set_api_key. Get a key at https://bereach.ai/token" };
     }
 
     const params: Record<string, unknown> = ctx?.params ?? ctx?.input ?? {};

package/src/index.ts

@@ -17,6 +17,7 @@ const log = createLogger("init");
 /** Guard against multiple register() calls with the same api instance */
 const registeredApis = new WeakSet<object>();
 let registeredCount = 0;
+let autoDetectDone = false;
 
 /**
  * Resolve the BeReach API key from all supported sources (in priority order):
@@ -32,6 +33,86 @@ export function resolveApiKey(api: any): string | undefined {
   return typeof key === "string" && key.trim().length > 0 ? key.trim() : undefined;
 }
 
+/**
+ * Auto-detect LLM provider from available API keys and set workspace defaults.
+ *
+ * Runs once at install time. If the workspace still has Anthropic defaults but
+ * no ANTHROPIC_API_KEY is available (only GEMINI_API_KEY), switches to Gemini
+ * models automatically. This prevents tasks from failing because the default
+ * models require an API key the user doesn't have.
+ *
+ * Does nothing if:
+ * - Already ran this session (idempotent guard)
+ * - ANTHROPIC_API_KEY is available (defaults are correct)
+ * - No GEMINI_API_KEY available (nothing to switch to)
+ * - User already changed models from defaults (respects manual choice)
+ */
+async function autoDetectModels(apiKey: string): Promise<void> {
+  if (autoDetectDone) return;
+  autoDetectDone = true;
+
+  const hasAnthropic = !!readEnv("ANTHROPIC_API_KEY");
+  const hasGemini = !!(readEnv("GEMINI_API_KEY") || readEnv("GOOGLE_API_KEY"));
+
+  // If Anthropic key exists, defaults are already correct
+  if (hasAnthropic) {
+    log("model auto-detect: Anthropic key available, keeping defaults");
+    return;
+  }
+
+  // If no Gemini key either, nothing we can switch to
+  if (!hasGemini) {
+    log("model auto-detect: no LLM provider keys found, skipping");
+    return;
+  }
+
+  // Gemini key available, no Anthropic key - check if we need to switch
+  try {
+    const res = await fetch(`${API_BASE}/me/settings`, {
+      headers: { Authorization: `Bearer ${apiKey}` },
+      signal: AbortSignal.timeout(5000),
+    });
+    if (!res.ok) {
+      log(`model auto-detect: settings GET failed (HTTP ${res.status}), skipping`);
+      return;
+    }
+
+    const data = await res.json() as {
+      aiModels?: { fast?: string; creative?: string };
+    };
+    const currentFast = data.aiModels?.fast;
+    const currentCreative = data.aiModels?.creative;
+
+    // Only auto-switch if still on Anthropic defaults (respect manual choices)
+    if (
+      currentFast === "anthropic/claude-haiku-4-5" &&
+      currentCreative === "anthropic/claude-sonnet-4-6"
+    ) {
+      const patchRes = await fetch(`${API_BASE}/me/settings`, {
+        method: "PATCH",
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+          aiFastModel: "google/gemini-2.5-flash",
+          aiCreativeModel: "google/gemini-2.5-pro",
+        }),
+        signal: AbortSignal.timeout(5000),
+      });
+      if (patchRes.ok) {
+        log("model auto-detect: no Anthropic key, Gemini key found - switched to Gemini Flash (fast) + Gemini Pro (creative)");
+      } else {
+        log(`model auto-detect: PATCH failed (HTTP ${patchRes.status})`);
+      }
+    } else {
+      log("model auto-detect: models already customized, skipping");
+    }
+  } catch (err) {
+    log(`model auto-detect: ${err instanceof Error ? err.message : String(err)}`);
+  }
+}
+
 export default function register(api: any) {
   if (api && typeof api === "object" && registeredApis.has(api)) {
     log(`skip duplicate register() call (same api instance, call #${registeredCount + 1})`);
@@ -127,6 +208,15 @@ export default function register(api: any) {
     }
   }
 
+  // Auto-detect LLM provider and set workspace model defaults.
+  // Runs before connector start so tasks use the correct models from the first poll.
+  // Fire-and-forget — non-critical, must not block registration.
+  if (apiKey) {
+    autoDetectModels(apiKey).catch((err) => {
+      log(`model auto-detect error: ${err instanceof Error ? err.message : String(err)}`);
+    });
+  }
+
   // Auto-start connector if API key is present and connector is enabled.
   // Skip when running as an agent child process (openclaw agent) — each child
   // would start its own polling loop, stealing tasks from the main connector.

package/src/tools/index.ts

@@ -127,7 +127,7 @@ export function registerAllTools(api: any, taskType?: string) {
   let skipped = 0;
 
   for (const def of definitions) {
-    if (!def.apiPath && def.handler !== "__self_upgrade__" && def.handler !== "__local__") {
+    if (!def.apiPath && def.handler !== "__self_upgrade__" && def.handler !== "__local__" && def.handler !== "__set_api_key__") {
       console.warn(`[bereach:tools] SKIP ${def.name}: no apiPath defined`);
       continue;
     }
@@ -148,10 +148,29 @@ export function registerAllTools(api: any, taskType?: string) {
           return executeSelfUpgrade();
         }
 
+        if (def.handler === "__set_api_key__") {
+          const key = String(params.apiKey ?? "").trim();
+          if (!key || !key.startsWith("brc_")) {
+            return {
+              content: [{ type: "text" as const, text: JSON.stringify({ success: false, error: "Invalid key format. Must start with brc_. Get your key at https://bereach.ai/token" }) }],
+            };
+          }
+
+          if (typeof api?.config?.set !== "function") {
+            return {
+              content: [{ type: "text" as const, text: JSON.stringify({ success: false, error: "Config API not available. Set BEREACH_API_KEY as an environment variable instead." }) }],
+            };
+          }
+          api.config.set("plugins.entries.bereach-openclaw.config.BEREACH_API_KEY", key);
+          return {
+            content: [{ type: "text" as const, text: JSON.stringify({ success: true, message: `API key saved (…${key.slice(-6)}). Tell the user to run: openclaw gateway restart, then /new` }) }],
+          };
+        }
+
         const apiKey = resolveApiKey(api);
         if (!apiKey) {
           return {
-            content: [{ type: "text" as const, text: JSON.stringify({ success: false, error: "BEREACH_API_KEY not configured. The user should get their key at https://bereach.ai/token and set it with: /bereach-set-key brc_THEIR_KEY" }) }],
+            content: [{ type: "text" as const, text: JSON.stringify({ success: false, error: "BEREACH_API_KEY not configured. The user should provide their key so you can call bereach_set_api_key. Get a key at https://bereach.ai/token" }) }],
           };
         }