memory-search-plugin 0.2.0 → 0.4.0

package/identity.ts

@@ -1,8 +1,11 @@
 /**
  * 身份解析模块
  *
- * 从 sessionKey 中解析出当前会话的身份类型和场景。
- * sessionKey 格式参考 V1.4 文档和 memory-privacy/identity.ts
+ * 方案 4：从 LLM 传入的工具参数解析身份信息。
+ * LLM 从 system prompt 中的 UntrustedContext 提取字段并填入工具参数。
+ *
+ * owner 判断：通过环境变量 OPENCLAW_GATEWAY_TOKEN 获取 owner_id，
+ * 与 sender_id 比对（与旧版逻辑一致）。
  *
  * 输出：
  *   - scene:    对应后端 SearchRequest.scene（private_own / private_other / group）
@@ -25,22 +28,26 @@ export interface ResolvedIdentity {
   group_id: string | null;
 }
 
+/** LLM 传入的身份相关参数（来自 UntrustedContext） */
+export interface IdentityParams {
+  sender_id?: string;
+  conversation_type?: string;  // "direct" | "group"
+  group_id?: string;
+}
+
 /**
- * 从 sessionKey 解析身份 + 场景
+ * 从 LLM 工具参数解析身份 + 场景
  *
- * sessionKey 末段格式:
- *   owner/peer: user_{userId}_lobster_{lobsterId}_release_{version}
- *   group:      user_{userId}_lobster_{lobsterId}_group_{groupId}_release_{version}
+ * owner 判断逻辑与旧版一致：通过环境变量 OPENCLAW_GATEWAY_TOKEN 获取 owner_id，
+ * 再与 sender_id 比对。
  *
  * 场景映射:
- *   owner（私聊自己的 agent）→ scene = "private_own"
- *   peer （私聊别人的 agent）→ scene = "private_other"
- *   group（群聊中 agent 回复）→ scene = "group"
+ *   conversation_type="group"                      → scene = "group"
+ *   conversation_type="direct" + isOwner(sender_id) → scene = "private_own"
+ *   conversation_type="direct" + !isOwner           → scene = "private_other"
  */
-export function resolveIdentity(sessionKey: string | undefined): ResolvedIdentity {
+export function resolveIdentityFromParams(params: IdentityParams): ResolvedIdentity {
   // ── 测试模式：环境变量覆盖 ──────────────────────────
-  // 设置 MEMORY_GATEWAY_TEST_SCENE 即可跳过 sessionKey 解析，
-  // 方便在没有真实 IM 会话时测试插件。
   const testScene = process.env.MEMORY_GATEWAY_TEST_SCENE as Scene | undefined;
   if (testScene) {
     const result: ResolvedIdentity = {
@@ -52,23 +59,39 @@ export function resolveIdentity(sessionKey: string | undefined): ResolvedIdentit
     return result;
   }
 
-  // ── 正常模式：从 sessionKey 解析 ──────────────────────
+  const userId = params.sender_id?.trim() || "unknown";
+  const convType = (params.conversation_type || "direct").trim().toLowerCase();
+
+  // 1. 群聊
+  if (convType === "group") {
+    return {
+      scene: "group",
+      user_id: userId,
+      group_id: params.group_id?.trim() || null,
+    };
+  }
+
+  // 2. 私聊：通过环境变量比对 owner_id 判断 owner/peer
+  if (isOwner(userId)) {
+    return { scene: "private_own", user_id: userId, group_id: null };
+  }
+
+  return { scene: "private_other", user_id: userId, group_id: null };
+}
+
+// ── 向后兼容：保留旧函数签名，sessionKey 仍可用时作为 fallback ──
+
+export function resolveIdentity(sessionKey: string | undefined): ResolvedIdentity {
   const sk = sessionKey ?? "";
   const sessionPart = sk.split(":").pop() || "";
 
-  // 1. 群聊: 包含 _group_
   const groupMatch = sessionPart.match(
     /user_(.+?)_lobster_(.+?)_group_(.+?)_release_(.+)$/
   );
   if (groupMatch) {
-    return {
-      scene: "group",
-      user_id: groupMatch[1],
-      group_id: groupMatch[3],
-    };
+    return { scene: "group", user_id: groupMatch[1], group_id: groupMatch[3] };
   }
 
-  // 2. 私聊 (owner 或 peer)
   const peerMatch = sessionPart.match(
     /user_(.+?)_lobster_(.+?)_release_(.+)$/
   );
@@ -80,15 +103,9 @@ export function resolveIdentity(sessionKey: string | undefined): ResolvedIdentit
     return { scene: "private_other", user_id: userId, group_id: null };
   }
 
-  // 3. 兜底: 安全起见当作 peer（private_other）
   return { scene: "private_other", user_id: "unknown", group_id: null };
 }
 
-/**
- * 判断是否是 owner
- * 通过环境变量 OPENCLAW_GATEWAY_TOKEN 判断
- * token 格式: oc-user-{ownerUserId}
- */
 function isOwner(userId: string): boolean {
   const token = process.env.OPENCLAW_GATEWAY_TOKEN || "";
   if (!token) return false;
@@ -96,10 +113,6 @@ function isOwner(userId: string): boolean {
   return ownerUserId !== "" && ownerUserId === userId;
 }
 
-/**
- * 从 sessionKey 提取 agent_id
- * sessionKey 格式: agent:{agentId}:palz:...
- */
 export function extractAgentId(sessionKey: string | undefined): string {
   const parts = (sessionKey || "").split(":");
   return parts.length >= 2 ? parts[1] : "main";

package/index.ts

@@ -26,7 +26,8 @@
 
 import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
 import { createGatewayClient } from "./gateway-client";
-import { resolveIdentity, extractAgentId } from "./identity";
+import { resolveIdentityFromParams, resolveIdentity, extractAgentId } from "./identity";
+import type { IdentityParams } from "./identity";
 import type { MemorySearchResult } from "./gateway-client";
 
 // ── Prompt Section ──────────────────────────────────────
@@ -64,6 +65,14 @@ const buildPromptSection = ({
 
   const lines = ["## Memory Recall", toolGuidance];
 
+  lines.push(
+    "**Context extraction:** When calling memory_search or memory_get, " +
+    "you MUST fill in the agent_id, sender_id, conversation_type, and group_id parameters " +
+    "by extracting them from the UntrustedContext section in this conversation. " +
+    "Look for lines like `agent_id: xxx`, `sender_id: xxx`, `conversation_type: xxx`, `group_id: xxx`. " +
+    "If a field is not present, omit it."
+  );
+
   if (citationsMode === "off") {
     lines.push(
       "Citations are disabled: do not mention file paths or line numbers in replies unless the user explicitly asks."
@@ -78,7 +87,7 @@ const buildPromptSection = ({
   return lines;
 };
 
-// ── 路径判断 ───────────────────────────────────────────���
+// ── 路径判断 ────────────────────────────────────────────
 
 /**
  * 判断是否是 MEMORY 路径
@@ -155,13 +164,15 @@ export default definePluginEntry({
     // ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
     api.registerTool(
       (ctx: any) => {
-        const identity = resolveIdentity(ctx.sessionKey);
-        const agentId = extractAgentId(ctx.sessionKey);
+        // fallback: 如果 sessionKey 仍可用，保留兼容
+        const fallbackIdentity = ctx.sessionKey ? resolveIdentity(ctx.sessionKey) : null;
+        const fallbackAgentId = ctx.sessionKey ? extractAgentId(ctx.sessionKey) : null;
 
         return {
           name: "memory_search",
           description:
-            "Semantically search MEMORY.md and memory/**/*.md for relevant memories.",
+            "Semantically search MEMORY.md and memory/**/*.md for relevant memories. " +
+            "You MUST extract agent_id, sender_id, conversation_type, group_id from the UntrustedContext in this conversation and pass them as parameters.",
           parameters: {
             type: "object" as const,
             properties: {
@@ -169,6 +180,22 @@ export default definePluginEntry({
                 type: "string" as const,
                 description: "The search query",
               },
+              agent_id: {
+                type: "string" as const,
+                description: "The agent_id from UntrustedContext (e.g. 'main' or 'lobster_xxx')",
+              },
+              sender_id: {
+                type: "string" as const,
+                description: "The sender_id from UntrustedContext",
+              },
+              conversation_type: {
+                type: "string" as const,
+                description: "The conversation_type from UntrustedContext: 'direct' or 'group'",
+              },
+              group_id: {
+                type: "string" as const,
+                description: "The group_id from UntrustedContext (only present in group chats)",
+              },
               maxResults: {
                 type: "number" as const,
                 description: "Maximum number of results to return",
@@ -183,7 +210,15 @@ export default definePluginEntry({
 
           async execute(
             toolCallId: string,
-            params: { query?: string; maxResults?: number; minScore?: number }
+            params: {
+              query?: string;
+              agent_id?: string;
+              sender_id?: string;
+              conversation_type?: string;
+              group_id?: string;
+              maxResults?: number;
+              minScore?: number;
+            }
           ) {
             const query = params.query || "";
             if (!query) {
@@ -192,8 +227,23 @@ export default definePluginEntry({
               };
             }
 
+            // 优先用 LLM 传参，fallback 到 sessionKey 解析
+            const agentId = params.agent_id?.trim() || fallbackAgentId || "main";
+            const identity = (params.sender_id || params.conversation_type || params.group_id)
+              ? resolveIdentityFromParams({
+                  sender_id: params.sender_id,
+                  conversation_type: params.conversation_type,
+                  group_id: params.group_id,
+                })
+              : (fallbackIdentity || resolveIdentityFromParams({}));
+
+            console.log(
+              `[memory-search-plugin] search: agent_id=${agentId} scene=${identity.scene} ` +
+              `user_id=${identity.user_id} group_id=${identity.group_id} ` +
+              `(source=${params.sender_id ? "llm_params" : "fallback"})`
+            );
+
             try {
-              // 按后端 SearchRequest 格式发送请求
               const data = await gateway.callGatewaySearch({
                 agent_id: agentId,
                 user_id: identity.user_id,
@@ -218,10 +268,9 @@ export default definePluginEntry({
             } catch (err: any) {
               console.error("[memory-search-plugin] search failed:", err.message);
 
-              // ── 降级：尝试用原始的 memory_search ──
               try {
                 const fallbackTool =
-                  api.runtime.tools.createMemorySearchTool({
+                  api.runtime?.tools?.createMemorySearchTool({
                     config: ctx.config,
                     agentSessionKey: ctx.sessionKey,
                   });
@@ -229,10 +278,10 @@ export default definePluginEntry({
                   console.warn(
                     "[memory-search-plugin] falling back to local memory_search"
                   );
-                  return await fallbackTool.execute(toolCallId, params);
+                  return await fallbackTool.execute(toolCallId, { query, maxResults: params.maxResults, minScore: params.minScore });
                 }
               } catch {
-                // 降级也失败，返回错误信息
+                // 降级也失败
               }
 
               return {
@@ -257,20 +306,15 @@ export default definePluginEntry({
     // ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
     api.registerTool(
       (ctx: any) => {
-        const identity = resolveIdentity(ctx.sessionKey);
-        const agentId = extractAgentId(ctx.sessionKey);
-
-        // 获取原始 memory_get 实现，用于非 MEMORY 路径的 passthrough
-        const originalGetTool = api.runtime.tools.createMemoryGetTool({
-          config: ctx.config,
-          agentSessionKey: ctx.sessionKey,
-        });
+        const fallbackIdentity = ctx.sessionKey ? resolveIdentity(ctx.sessionKey) : null;
+        const fallbackAgentId = ctx.sessionKey ? extractAgentId(ctx.sessionKey) : null;
 
         return {
           name: "memory_get",
           description:
             "Read a memory file or workspace file. " +
-            "Supports reading MEMORY.md, memory/**/*.md, and other workspace files.",
+            "Supports reading MEMORY.md, memory/**/*.md, and other workspace files. " +
+            "You MUST extract agent_id, sender_id, conversation_type, group_id from the UntrustedContext in this conversation and pass them as parameters.",
           parameters: {
             type: "object" as const,
             properties: {
@@ -279,6 +323,22 @@ export default definePluginEntry({
                 description:
                   "Relative path to the file (e.g. MEMORY.md, memory/notes.md, SOUL.md)",
               },
+              agent_id: {
+                type: "string" as const,
+                description: "The agent_id from UntrustedContext (e.g. 'main' or 'lobster_xxx')",
+              },
+              sender_id: {
+                type: "string" as const,
+                description: "The sender_id from UntrustedContext",
+              },
+              conversation_type: {
+                type: "string" as const,
+                description: "The conversation_type from UntrustedContext: 'direct' or 'group'",
+              },
+              group_id: {
+                type: "string" as const,
+                description: "The group_id from UntrustedContext (only present in group chats)",
+              },
               from: {
                 type: "number" as const,
                 description: "Starting line number (1-indexed)",
@@ -293,7 +353,15 @@ export default definePluginEntry({
 
           async execute(
             toolCallId: string,
-            params: { path?: string; from?: number; lines?: number }
+            params: {
+              path?: string;
+              agent_id?: string;
+              sender_id?: string;
+              conversation_type?: string;
+              group_id?: string;
+              from?: number;
+              lines?: number;
+            }
           ) {
             const path = params.path || "";
             if (!path) {
@@ -302,11 +370,34 @@ export default definePluginEntry({
               };
             }
 
+            // 懒加载原始 memory_get 实现，用于非 MEMORY 路径的 passthrough
+            let originalGetTool: any = null;
+            try {
+              originalGetTool = api.runtime?.tools?.createMemoryGetTool({
+                config: ctx.config,
+                agentSessionKey: ctx.sessionKey,
+              });
+            } catch {
+              // memory-core 被替换后 api.runtime.tools 不可用，忽略
+            }
+
             // ── 路径分流 ──
             if (isMemoryPath(path)) {
-              // MEMORY 路径 → 调 Gateway（带 ACL）
+              const agentId = params.agent_id?.trim() || fallbackAgentId || "main";
+              const identity = (params.sender_id || params.conversation_type || params.group_id)
+                ? resolveIdentityFromParams({
+                    sender_id: params.sender_id,
+                    conversation_type: params.conversation_type,
+                    group_id: params.group_id,
+                  })
+                : (fallbackIdentity || resolveIdentityFromParams({}));
+
+              console.log(
+                `[memory-search-plugin] get: path=${path} agent_id=${agentId} scene=${identity.scene} ` +
+                `user_id=${identity.user_id} (source=${params.sender_id ? "llm_params" : "fallback"})`
+              );
+
               try {
-                // 按后端 GetRequest 格式发送请求
                 const data = await gateway.callGatewayGet({
                   agent_id: agentId,
                   user_id: identity.user_id,
@@ -324,7 +415,6 @@ export default definePluginEntry({
               } catch (err: any) {
                 console.error("[memory-search-plugin] get failed:", err.message);
 
-                // 403 明确拒绝 → 不降级，直接返回拒绝
                 if (err.message?.includes('403')) {
                   return {
                     content: [
@@ -336,13 +426,12 @@ export default definePluginEntry({
                   };
                 }
 
-                // 其他错误（网络不通等）→ 降级到本地文件读取
                 if (originalGetTool) {
                   console.warn(
                     "[memory-search-plugin] falling back to local memory_get for:",
                     path
                   );
-                  return await originalGetTool.execute(toolCallId, params);
+                  return await originalGetTool.execute(toolCallId, { path, from: params.from, lines: params.lines });
                 }
 
                 return {
@@ -356,10 +445,8 @@ export default definePluginEntry({
                 };
               }
             } else {
-              // 非 MEMORY 路径 → passthrough 给原始实现
-              // 这样 SOUL.md、rules.md 等文件的读取行为完全不变
               if (originalGetTool) {
-                return await originalGetTool.execute(toolCallId, params);
+                return await originalGetTool.execute(toolCallId, { path, from: params.from, lines: params.lines });
               }
 
               return {
@@ -382,7 +469,11 @@ export default definePluginEntry({
     // ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
     api.registerCli(
       ({ program }: any) => {
-        api.runtime.tools.registerMemoryCli(program);
+        try {
+          api.runtime?.tools?.registerMemoryCli(program);
+        } catch {
+          // memory-core 被替换后 api.runtime.tools 不可用，忽略
+        }
       },
       { commands: ["memory"] }
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "memory-search-plugin",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "type": "module",
   "main": "index.ts",
   "files": [