@modelstudio/modelstudio-memory-for-openclaw 1.0.0 → 1.0.2

package/README.md

@@ -57,8 +57,8 @@ openclaw modelstudio-memory stats
         enabled: true,
         config: {
           // 必需配置
-          "apiKey": "${DASHSCOPE_API_KEY}",
-          "userId": "user_001",
+          "apiKey": "your-dashscope-api-key",
+          "userId": "openclaw_memory",
           
           // 可选配置（以下为默认值）
           "baseUrl": "https://dashscope.aliyuncs.com/api/v2/apps/memory",
@@ -80,8 +80,8 @@ openclaw modelstudio-memory stats
 
 | 配置项 | 类型 | 必需 | 默认值 | 说明 |
 |--------|------|------|--------|------|
-| `apiKey` | `string` | ✅ | - | DashScope API Key，支持 `${ENV_VAR}` 格式 |
-| `userId` | `string` | ✅ | - | 用户 ID，用于隔离不同用户的记忆 |
+| `apiKey` | `string` | ✅ | - | DashScope API Key（在 openclaw.json 中配置） |
+| `userId` | `string` | ❌ | `openclaw_memory` | 用户 ID，用于隔离不同用户的记忆 |
 | `baseUrl` | `string` | ❌ | `https://dashscope.aliyuncs.com/api/v2/apps/memory` | API endpoint（私有部署时填写完整 URL） |
 | `autoCapture` | `boolean` | ❌ | `true` | 是否自动捕获对话 |
 | `autoRecall` | `boolean` | ❌ | `true` | 是否自动召回记忆 |
@@ -91,17 +91,11 @@ openclaw modelstudio-memory stats
 | `recallMinPromptLength` | `number` | ❌ | `10` | 触发自动召回的最小 prompt 长度 |
 | `recallCacheTtlMs` | `number` | ❌ | `300000` | 召回缓存时间（毫秒），0 禁用缓存 |
 
-## 环境变量
+## 获取 API Key
 
-```bash
-# 设置 DashScope API Key
-export DASHSCOPE_API_KEY="your-api-key"
-
-# 重启 Gateway
-openclaw gateway restart
-```
+在 [阿里云百炼控制台](https://help.aliyun.com/zh/model-studio/get-api-key) 获取 DashScope API Key，并在 `openclaw.json` 的 `config.apiKey` 中配置。
 
-获取 API Key：https://help.aliyun.com/zh/model-studio/get-api-key
+**提示**：若安装后未配置 apiKey，插件仍会加载。当用户使用记忆功能（如询问「我之前说过什么」）时，Agent 会提示用户配置 apiKey。
 
 ## 使用方法
 
@@ -230,7 +224,7 @@ tail -f ~/.openclaw/logs/gateway.log | grep modelstudio-memory
 
 | 错误 | 原因 | 解决方案 |
 |------|------|----------|
-| `apiKey is required` | 未配置 API Key | 设置 `DASHSCOPE_API_KEY` 环境变量 |
+| `apiKey is required` | 未配置 API Key | 在 openclaw.json 的 config 中配置 apiKey |
 | `InvalidApiKey` | API Key 无效 | 检查 API Key 是否正确 |
 | `TooManyRequests` | 请求频率过高 | 降低调用频率 |
 

package/index.ts

@@ -80,14 +80,6 @@ const ALLOWED_KEYS = [
   "recallCacheTtlMs",
 ];
 
-function resolveEnvVars(value: string): string {
-  if (!value) return value;
-  return value.replace(/\$\{([^}]+)\}/g, (_, key) => {
-    const envValue = process.env[key];
-    return envValue || "";
-  });
-}
-
 function assertAllowedKeys(
   value: Record<string, unknown>,
   allowed: string[],
@@ -106,17 +98,9 @@ const modelstudioMemoryConfigSchema = {
     const cfg = value as Record<string, unknown>;
     assertAllowedKeys(cfg, ALLOWED_KEYS, "modelstudio-memory-for-openclaw config");
 
-    // apiKey is required
-    const apiKey = typeof cfg.apiKey === "string" ? resolveEnvVars(cfg.apiKey) : "";
-    if (!apiKey) {
-      throw new Error("apiKey is required for modelstudio-memory-for-openclaw");
-    }
-
-    // userId is required
-    const userId = typeof cfg.userId === "string" ? cfg.userId : "";
-    if (!userId) {
-      throw new Error("userId is required for modelstudio-memory-for-openclaw");
-    }
+    // apiKey: allow empty at parse time; tools return config prompt when missing
+    const apiKey = typeof cfg.apiKey === "string" ? cfg.apiKey : "";
+    const userId = typeof cfg.userId === "string" && cfg.userId ? cfg.userId : "openclaw_memory";
 
     return {
       apiKey,
@@ -373,6 +357,9 @@ function stripInjectedContext(text: string): string {
   return text.replace(/<relevant-memories>[\s\S]*?<\/relevant-memories>\s*/g, "").trim();
 }
 
+const CONFIG_REQUIRED_MESSAGE =
+  "Memory plugin is not configured. Please add apiKey and userId to ~/.openclaw/openclaw.json under plugins.entries.modelstudio-memory-for-openclaw.config. Get API Key: https://help.aliyun.com/zh/model-studio/get-api-key";
+
 // ============================================================================
 // Plugin Definition
 // ============================================================================
@@ -393,6 +380,11 @@ const modelstudioMemoryPlugin = {
       api.logger
     );
 
+    if (!cfg.apiKey) {
+      api.logger.warn(
+        "modelstudio-memory: apiKey not configured. Memory features disabled until config is added to openclaw.json."
+      );
+    }
     api.logger.info(
       `modelstudio-memory: registered (user: ${cfg.userId}, autoCapture: ${cfg.autoCapture}, autoRecall: ${cfg.autoRecall})`
     );
@@ -413,6 +405,12 @@ const modelstudioMemoryPlugin = {
           ),
         }),
         async execute(_id, params) {
+          if (!cfg.apiKey) {
+            return {
+              content: [{ type: "text", text: CONFIG_REQUIRED_MESSAGE }],
+              isError: true,
+            };
+          }
           try {
             const limit = Math.min(
               Math.max(1, params.limit ?? cfg.topK),
@@ -484,6 +482,12 @@ const modelstudioMemoryPlugin = {
           content: Type.String({ description: "Content to store" }),
         }),
         async execute(_id, params) {
+          if (!cfg.apiKey) {
+            return {
+              content: [{ type: "text", text: CONFIG_REQUIRED_MESSAGE }],
+              isError: true,
+            };
+          }
           try {
             const result = await client.addCustomContent(params.content);
 
@@ -529,6 +533,12 @@ const modelstudioMemoryPlugin = {
           ),
         }),
         async execute(_id, params) {
+          if (!cfg.apiKey) {
+            return {
+              content: [{ type: "text", text: CONFIG_REQUIRED_MESSAGE }],
+              isError: true,
+            };
+          }
           try {
             const page = Math.max(1, params.page ?? 1);
             const pageSize = Math.min(100, Math.max(1, params.pageSize ?? 10));
@@ -589,6 +599,12 @@ const modelstudioMemoryPlugin = {
           index: Type.Optional(Type.Number({ description: "Delete Nth memory (1-based)" })),
         }),
         async execute(_id, params) {
+          if (!cfg.apiKey) {
+            return {
+              content: [{ type: "text", text: CONFIG_REQUIRED_MESSAGE }],
+              isError: true,
+            };
+          }
           try {
             let targetId = params.memoryId;
 
@@ -706,6 +722,7 @@ const modelstudioMemoryPlugin = {
     // ========== autoRecall ==========
     if (cfg.autoRecall) {
       api.on("before_agent_start", async (event) => {
+        if (!cfg.apiKey) return;
         const prompt = extractTextContent(event.prompt);
         if (!prompt || prompt.length < cfg.recallMinPromptLength) {
           return;
@@ -739,7 +756,7 @@ const modelstudioMemoryPlugin = {
     // ========== autoCapture ==========
     if (cfg.autoCapture) {
       api.on("agent_end", async (event) => {
-        if (!event.success || !event.messages) {
+        if (!cfg.apiKey || !event.success || !event.messages) {
           return;
         }
 
@@ -814,6 +831,10 @@ const modelstudioMemoryPlugin = {
           .argument("<query>", "Search query")
           .option("--limit <n>", "Max results", String(cfg.topK))
           .action(async (query: string, opts: { limit: string }) => {
+            if (!cfg.apiKey) {
+              console.error(CONFIG_REQUIRED_MESSAGE);
+              return;
+            }
             try {
               const limit = Math.min(100, Math.max(1, parseInt(opts.limit, 10) || cfg.topK));
               const cleanQuery = extractTextContent(query) || query.trim();
@@ -848,6 +869,10 @@ const modelstudioMemoryPlugin = {
           .command("stats")
           .description("Show memory statistics")
           .action(async () => {
+            if (!cfg.apiKey) {
+              console.error(CONFIG_REQUIRED_MESSAGE);
+              return;
+            }
             try {
               const result = await client.listMemory(1, 1);
               console.log(`User: ${cfg.userId}`);
@@ -867,6 +892,10 @@ const modelstudioMemoryPlugin = {
           .option("--page <n>", "Page number", "1")
           .option("--size <n>", "Page size", "10")
           .action(async (opts: { page: string; size: string }) => {
+            if (!cfg.apiKey) {
+              console.error(CONFIG_REQUIRED_MESSAGE);
+              return;
+            }
             try {
               const page = Math.max(1, parseInt(opts.page, 10) || 1);
               const size = Math.min(100, Math.max(1, parseInt(opts.size, 10) || 10));

package/openclaw.plugin.json

@@ -3,18 +3,18 @@
   "name": "modelstudio-memory-for-openclaw",
   "description": "阿里云百炼长期记忆服务，提供自动记忆捕获和召回能力",
   "kind": "memory",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "configSchema": {
     "type": "object",
     "additionalProperties": false,
     "properties": {
       "apiKey": {
         "type": "string",
-        "description": "DashScope API Key（支持环境变量 ${DASHSCOPE_API_KEY}）"
+        "description": "DashScope API Key"
       },
       "userId": {
         "type": "string",
-        "description": "用户 ID，用于隔离不同用户的记忆"
+        "description": "用户 ID，用于隔离不同用户的记忆（默认 'openclaw_memory'）"
       },
       "baseUrl": {
         "type": "string",
@@ -62,11 +62,11 @@
     "apiKey": {
       "label": "API Key",
       "sensitive": true,
-      "placeholder": "${DASHSCOPE_API_KEY}"
+      "placeholder": "sk-..."
     },
     "userId": {
       "label": "用户 ID",
-      "placeholder": "user_001"
+      "placeholder": "openclaw_memory"
     },
     "baseUrl": {
       "label": "API Endpoint",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modelstudio/modelstudio-memory-for-openclaw",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "阿里云百炼长期记忆服务 OpenClaw 插件",
   "license": "Apache-2.0",