@workclaw/openclaw-workclaw 1.0.17 → 1.0.18

package/README.md

@@ -224,7 +224,6 @@ openclaw-workclaw/
 调用：openclaw-workclaw-cron-add-params({ time: "5m", name: "喝水提醒", message: "该喝水了" })
 
 步骤2：使用返回的 cronParams 调用 OpenClaw cron 工具
-
 步骤3：从 cron 工具返回值中提取 jobId（如 "7382945612345"）
 
 步骤4：调用后端同步
@@ -233,6 +232,27 @@ openclaw-workclaw/
 回复："⏰ 好的，5分钟后提醒你喝水~"
 ```
 
+### add-params 参数说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| time | string | 是 | 时间描述，支持相对时间（5m、1h）和 cron 表达式 |
+| name | string | 是 | 任务名称 |
+| message | string | 是 | 提醒内容 |
+
+> **注意**：`account` 参数不需要传入，会自动从 `ctx.agentAccountId` 获取
+
+### update-params 参数说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| jobId | string | 是 | OpenClaw 任务 ID |
+| time | string | 是 | 时间描述，支持相对时间（5m、1h）和 cron 表达式 |
+| name | string | 是 | 任务名称 |
+| message | string | 是 | 提醒内容 |
+
+> **注意**：`account` 参数不需要传入，会自动从 `ctx.agentAccountId` 获取
+
 ## 🌐 HTTP API
 
 插件提供以下 HTTP API 接口：

package/index.ts

@@ -1,302 +1,302 @@
-import type { OpenClawPluginApi } from 'openclaw/plugin-sdk'
-import { mkdir, readFile, writeFile } from 'node:fs/promises'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-import { emptyPluginConfigSchema } from 'openclaw/plugin-sdk'
-import { createAccountsApiHandler } from './src/api/accounts-api.js'
-import { createPromptsApiHandler } from './src/api/prompts-api.js'
-import { createSessionApiHandler } from './src/api/session-api.js'
-import { createSkillsApiHandler } from './src/api/skills-api.js'
-import { isDefaultWorkspace, resolveWorkspaceDir } from './src/api/workspace.js'
-import { openclawWorkclawPlugin } from './src/channel.js'
-import { sendMessageOpenclawWorkclaw } from './src/outbound/index.js'
-import { deleteToolContext, getOpenclawWorkclawRuntime, getToolContext, getToolResultHint, setOpenclawWorkclawRuntime, setToolCallIdToRunIdMapping } from './src/runtime.js'
-
-import { registerAllOpenclawWorkclawCronTools } from './src/tools/openclaw-workclaw-cron/index.js'
-import { registerAllOpenclawWorkclawSystemTools } from './src/tools/openclaw-workclaw-system/index.js'
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore - types from openclaw 4.2, local dev uses 3.13
+import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { workclawPlugin } from "./src/channel.js";
+import {
+  setWorkclawRuntime,
+  getWorkclawRuntime,
+  getToolResultHint,
+} from "./src/runtime.js";
+import { resolveWorkspaceDir, isDefaultWorkspace } from "./src/api/workspace.js";
+import { createPromptsApiHandler } from "./src/api/prompts-api.js";
+import { createAccountsApiHandler } from "./src/api/accounts-api.js";
+import { createSessionApiHandler } from "./src/api/session-api.js";
+import { createSkillsApiHandler } from "./src/api/skills-api.js";
+import { registerAllOpenclawWorkclawCronTools } from "./src/tools/openclaw-workclaw-cron/index.js";
+import {
+  getToolContext,
+  setToolCallIdToRunIdMapping,
+  deleteToolContext,
+} from "./src/runtime.js";
+import { sendMessageWorkclaw } from "./src/outbound/index.js";
+
+// ============================================================================
+// Tool output formatting helpers
+// ============================================================================
 
-/**
- * 根据工具名称格式化参数字符串
- */
 function formatToolParams(toolName: string | undefined, params: unknown): string {
-  if (!params || typeof params !== 'object') {
-    return ''
+  if (!params || typeof params !== "object") {
+    return "";
   }
 
-  const normalizedToolName = (toolName || '').toLowerCase().trim()
-  const p = params as Record<string, unknown>
+  const normalizedToolName = (toolName || "").toLowerCase().trim();
+  const p = params as Record<string, unknown>;
 
   try {
-    // exec/bash/shell: 显示 command
-    if (normalizedToolName === 'exec' || normalizedToolName === 'bash' || normalizedToolName === 'shell') {
-      const cmd = p.command || p.cmd
-      if (cmd)
-        return `command: ${String(cmd).slice(0, 200)}`
-    }
-    // read/file_read/read: 显示 path
-    else if (normalizedToolName === 'read' || normalizedToolName === 'file_read' || normalizedToolName === 'view') {
-      const path = p.path
-      if (path)
-        return `path: ${path}`
-    }
-    // write/file_write/write/edit/patch: 显示 path
-    else if (normalizedToolName === 'write' || normalizedToolName === 'file_write' || normalizedToolName === 'edit' || normalizedToolName === 'patch') {
-      const path = p.path
-      if (path)
-        return `path: ${path}`
-    }
-    // web_fetch/fetch/http_get/http_request/open_url/browser_open: 显示 url
-    else if (
-      normalizedToolName === 'web_fetch' || normalizedToolName === 'fetch'
-      || normalizedToolName === 'http_get' || normalizedToolName === 'http_request'
-      || normalizedToolName === 'open_url' || normalizedToolName === 'browser_open'
-      || normalizedToolName === 'open'
+    if (normalizedToolName === "exec" || normalizedToolName === "bash" || normalizedToolName === "shell") {
+      const cmd = p.command || p.cmd;
+      if (cmd) return `command: ${String(cmd).slice(0, 200)}`;
+    } else if (
+      normalizedToolName === "read" ||
+      normalizedToolName === "file_read" ||
+      normalizedToolName === "view"
     ) {
-      const url = p.url
-      if (url)
-        return `url: ${url}`
-    }
-    // search/web_search/google_search/browser_search: 显示 query
-    else if (
-      normalizedToolName === 'search' || normalizedToolName === 'web_search'
-      || normalizedToolName === 'google_search' || normalizedToolName === 'browser_search'
-      || normalizedToolName === 'browser.search'
+      const p2 = p.path;
+      if (p2) return `path: ${p2}`;
+    } else if (
+      normalizedToolName === "write" ||
+      normalizedToolName === "file_write" ||
+      normalizedToolName === "edit" ||
+      normalizedToolName === "patch"
     ) {
-      const query = p.query || p.q || p.search
-      if (query)
-        return `query: ${query}`
-    }
-    // image_generate/generate_image/dalle/text_to_image: 显示 prompt
-    else if (
-      normalizedToolName === 'image_generate' || normalizedToolName === 'generate_image'
-      || normalizedToolName === 'dalle' || normalizedToolName === 'text_to_image'
+      const p2 = p.path;
+      if (p2) return `path: ${p2}`;
+    } else if (
+      normalizedToolName === "web_fetch" ||
+      normalizedToolName === "fetch" ||
+      normalizedToolName === "http_get" ||
+      normalizedToolName === "http_request" ||
+      normalizedToolName === "open_url" ||
+      normalizedToolName === "browser_open" ||
+      normalizedToolName === "open"
     ) {
-      const prompt = p.prompt
-      if (prompt)
-        return `prompt: ${String(prompt).slice(0, 200)}`
-    }
-    // code_interpreter/python/jupyter: 显示 code
-    else if (
-      normalizedToolName === 'code_interpreter' || normalizedToolName === 'python'
-      || normalizedToolName === 'jupyter'
+      const u = p.url;
+      if (u) return `url: ${u}`;
+    } else if (
+      normalizedToolName === "search" ||
+      normalizedToolName === "web_search" ||
+      normalizedToolName === "google_search" ||
+      normalizedToolName === "browser_search" ||
+      normalizedToolName === "browser.search"
     ) {
-      const code = p.code
-      if (code)
-        return `code: ${String(code).slice(0, 200)}`
-    }
-    // mcp_deliver/deliver: 显示 target
-    else if (normalizedToolName === 'mcp_deliver' || normalizedToolName === 'deliver') {
-      const target = p.target || p.to
-      if (target)
-        return `target: ${target}`
-    }
-    // 其他工具：显示所有 key=value
-    else {
-      const entries = Object.entries(p)
+      const q = p.query || p.q || p.search;
+      if (q) return `query: ${q}`;
+    } else if (
+      normalizedToolName === "image_generate" ||
+      normalizedToolName === "generate_image" ||
+      normalizedToolName === "dalle" ||
+      normalizedToolName === "text_to_image"
+    ) {
+      const prompt = p.prompt;
+      if (prompt) return `prompt: ${String(prompt).slice(0, 200)}`;
+    } else if (
+      normalizedToolName === "code_interpreter" ||
+      normalizedToolName === "python" ||
+      normalizedToolName === "jupyter"
+    ) {
+      const code = p.code;
+      if (code) return `code: ${String(code).slice(0, 200)}`;
+    } else if (normalizedToolName === "mcp_deliver" || normalizedToolName === "deliver") {
+      const target = p.target || p.to;
+      if (target) return `target: ${target}`;
+    } else {
+      const entries = Object.entries(p);
       if (entries.length > 0) {
         return entries
           .map(([k, v]) => {
-            const vStr = typeof v === 'string' ? v : JSON.stringify(v)
-            return vStr.length > 100 ? `${k}: ${vStr.slice(0, 100)}...` : `${k}: ${vStr}`
+            const vStr = typeof v === "string" ? v : JSON.stringify(v);
+            return vStr.length > 100 ? `${k}: ${vStr.slice(0, 100)}...` : `${k}: ${vStr}`;
           })
-          .join('\n')
+          .join("\n");
       }
     }
-  }
-  catch {
-    return String(params)
+  } catch {
+    return String(params);
   }
 
-  return ''
+  return "";
 }
 
-/**
- * 组合工具输出内容（只显示参数）
- */
 function formatToolOutput(toolName: string | undefined, params: unknown, _result: unknown): string {
-  return formatToolParams(toolName, params)
+  return formatToolParams(toolName, params);
 }
 
-// 注册工具执行相关的 hook
-function registerToolHooks(api: OpenClawPluginApi): void {
-  // agent_end: 对话结束时清理 runId 映射
-  api.on('agent_end', (event: any, ctx: any) => {
-    const { runId } = ctx || {}
+// ============================================================================
+// Tool hooks
+// ============================================================================
+
+function registerToolHooks(api: OpenClawPluginApi) {
+  api.on("agent_end", (event: any, ctx: any) => {
+    const { runId } = ctx || {};
     if (runId) {
-      deleteToolContext(runId)
-      api.logger?.info?.(`[ToolHook] agent_end runId=${runId} cleaned up`)
+      deleteToolContext(runId);
+      api.logger?.info?.(`[ToolHook] agent_end runId=${runId} cleaned up`);
     }
-    return event
-  })
+    return event;
+  });
 
-  api.on('before_tool_call', (event: any) => {
-    api.logger?.info?.(`[ToolHook] before_tool_call event=${JSON.stringify(event)}`)
-  })
+  api.on("before_tool_call", (event: any, _ctx: any) => {
+    api.logger?.info?.(`[ToolHook] before_tool_call event=${JSON.stringify(event)}`);
+  });
 
-  // after_tool_call: 获取工具执行结果并推送
-  api.on('after_tool_call', (event: any) => {
-    api.logger?.info?.(`[ToolHook] after_tool_call event=${JSON.stringify(event)}`)
-    const { runId, toolCallId, toolName, params, result } = event || {}
-    const toolCtx = runId ? getToolContext(runId) : undefined
+  api.on("after_tool_call", (event: any, _ctx: any) => {
+    api.logger?.info?.(`[ToolHook] after_tool_call event=${JSON.stringify(event)}`);
+    const { runId, toolCallId, toolName, params, result } = event || {};
+    const toolCtx = runId ? getToolContext(runId) : undefined;
 
     if (toolCtx && result) {
-      const content = formatToolOutput(toolName, params, result)
+      const content = formatToolOutput(toolName, params, result);
       if (content) {
         try {
-          const cfg = getOpenclawWorkclawRuntime().config.loadConfig()
+          const cfg = getWorkclawRuntime().config.loadConfig();
           const formattedToolOutput = {
             name: getToolResultHint(toolName),
-            toolName,
-            content,
-            state: 'result',
-          }
-          sendMessageOpenclawWorkclaw({
+            toolName: toolName,
+            content: content,
+            state: "result",
+          };
+          sendMessageWorkclaw({
             cfg,
             to: toolCtx.target,
             text: JSON.stringify(formattedToolOutput),
-            msgType: '26',
+            msgType: "26",
             accountId: toolCtx.accountId,
             openConversationId: toolCtx.openConversationId,
             agentId: toolCtx.agentId,
             replyToMessageId: toolCtx.replyToMessageId,
           }).catch((err) => {
-            api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`)
-          })
-          api.logger?.info?.(`[ToolHook] after_tool_call pushed for toolName=${toolName}`)
-        }
-        catch (err) {
-          api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`)
+            api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`);
+          });
+          api.logger?.info?.(`[ToolHook] after_tool_call pushed for toolName=${toolName}`);
+        } catch (err) {
+          api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`);
         }
       }
     }
 
-    // 建立 toolCallId -> runId 映射（备用，用于 tool_result_persist）
     if (runId && toolCallId) {
-      setToolCallIdToRunIdMapping(toolCallId, runId)
+      setToolCallIdToRunIdMapping(toolCallId, runId);
     }
 
-    return event
-  })
+    return event;
+  });
 
-  // tool_result_persist: 仅返回消息，不推送
-  api.on('tool_result_persist', (event: any) => {
-    return { message: event.message }
-  })
+  api.on("tool_result_persist", (event: any, _ctx: any) => {
+    return { message: event.message };
+  });
 
-  api.logger?.info?.(`[ToolHook] Tool execution hooks registered`)
+  api.logger?.info?.(`[ToolHook] Tool execution hooks registered`);
 }
 
-export { openclawWorkclawPlugin } from './src/channel.js'
-export {
-  getMessageOpenclawWorkclaw,
-  sendMessageOpenclawWorkclaw,
-} from './src/outbound/index.js'
+// ============================================================================
+// Templates
+// ============================================================================
 
-const templateNames = ['SOUL.md', 'IDENTITY.md'] as const
+const templateNames = ["SOUL.md", "IDENTITY.md"] as const;
 
-async function writeFileIfMissing(filePath: string, content: string): Promise<void> {
+/**
+ * 获取插件所在目录，兼容 Windows 下的 file:// URL 问题。
+ * 4.2 的插件加载器在 Windows 上可能传入不带协议前缀的路径。
+ */
+function getPluginDir(): string {
   try {
-    await writeFile(filePath, content, { encoding: 'utf-8', flag: 'wx' })
+    const url = import.meta.url;
+    if (!url.startsWith("file://")) {
+      // Windows 路径被直接传入（不带 file:// 前缀），直接取目录
+      return path.dirname(url);
+    }
+    return path.dirname(fileURLToPath(url));
+  } catch {
+    return process.cwd();
   }
-  catch (error) {
+}
+
+async function writeFileIfMissing(filePath: string, content: string) {
+  try {
+    await writeFile(filePath, content, { encoding: "utf-8", flag: "wx" });
+  } catch (error) {
     if (
-      error
-      && typeof error === 'object'
-      && 'code' in error
-      && (error as NodeJS.ErrnoException).code === 'EEXIST'
+      error &&
+      typeof error === "object" &&
+      "code" in error &&
+      (error as NodeJS.ErrnoException).code === "EEXIST"
     ) {
-      return
+      return;
     }
-    throw error
+    throw error;
   }
 }
 
-async function releaseTemplates(api: OpenClawPluginApi): Promise<void> {
-  const workspaceDir = resolveWorkspaceDir(api)
+async function releaseTemplates(api: OpenClawPluginApi) {
+  const workspaceDir = resolveWorkspaceDir(api);
   // 模板文件在根目录的 templates/ 中，而不是 dist/templates/
-  const currentDir = path.dirname(fileURLToPath(import.meta.url))
-  const templatesDir = path.join(currentDir.endsWith('dist') ? path.dirname(currentDir) : currentDir, 'templates')
-  const shouldOverwrite = isDefaultWorkspace(api)
+  const currentDir = getPluginDir();
+  const templatesDir = path.join(
+    currentDir.endsWith("dist") ? path.dirname(currentDir) : currentDir,
+    "templates",
+  );
+  const shouldOverwrite = isDefaultWorkspace(api);
 
-  await mkdir(workspaceDir, { recursive: true })
+  await mkdir(workspaceDir, { recursive: true });
 
   await Promise.all(
     templateNames.map(async (name) => {
-      const sourcePath = path.join(templatesDir, name)
-      const targetPath = path.join(workspaceDir, name)
-      const content = await readFile(sourcePath, 'utf-8')
+      const sourcePath = path.join(templatesDir, name);
+      const targetPath = path.join(workspaceDir, name);
+      const content = await readFile(sourcePath, "utf-8");
       if (shouldOverwrite) {
-        await writeFile(targetPath, content, { encoding: 'utf-8' })
-      }
-      else {
-        await writeFileIfMissing(targetPath, content)
+        await writeFile(targetPath, content, { encoding: "utf-8" });
+      } else {
+        await writeFileIfMissing(targetPath, content);
       }
     }),
-  )
+  );
 
-  api.logger.info(`openclaw-workclaw templates ready: ${workspaceDir}`)
+  api.logger.info(`openclaw-workclaw templates ready: ${workspaceDir}`);
 }
 
-const plugin = {
-  id: 'openclaw-workclaw',
-  name: 'openclaw-workclaw',
-  description: '智小途 channel plugin',
-  configSchema: emptyPluginConfigSchema(),
-  register(api: OpenClawPluginApi) {
-    setOpenclawWorkclawRuntime(api.runtime)
-    api.registerChannel({ plugin: openclawWorkclawPlugin })
-
-    // 注册定时任务工具
-    registerAllOpenclawWorkclawCronTools(api)
+// ============================================================================
+// Plugin entry point
+// ============================================================================
 
-    // 注册系统工具
-    registerAllOpenclawWorkclawSystemTools(api)
+export default defineChannelPluginEntry({
+  id: "openclaw-workclaw",
+  name: "openclaw-workclaw",
+  description: "智小途 channel plugin",
+  configSchema: emptyPluginConfigSchema() as any,
+  plugin: workclawPlugin,
+  registerFull(api) {
+    setWorkclawRuntime(api.runtime);
 
-    // 注册工具执行相关的 hook - 不再需要留在这里当注释
-    registerToolHooks(api)
+    registerAllOpenclawWorkclawCronTools(api);
+    registerToolHooks(api);
 
     api.registerService({
-      id: 'openclaw-workclaw-templates',
+      id: "openclaw-workclaw-templates",
       start: async () => {
-        await releaseTemplates(api)
+        await releaseTemplates(api);
       },
-    })
+    });
 
     api.registerHttpRoute({
-      path: '/openclaw-workclaw/workspace/prompts',
+      path: "/openclaw-workclaw/workspace/prompts",
       handler: createPromptsApiHandler(api),
-      auth: 'plugin',
-    })
+      auth: "plugin",
+    });
 
     api.registerHttpRoute({
-      path: '/openclaw-workclaw/accounts',
+      path: "/openclaw-workclaw/accounts",
       handler: createAccountsApiHandler(api),
-      auth: 'plugin',
-    })
+      auth: "plugin",
+    });
 
     api.registerHttpRoute({
-      path: '/openclaw-workclaw/skills',
+      path: "/openclaw-workclaw/skills",
       handler: createSkillsApiHandler(api),
-      auth: 'plugin',
-    })
+      auth: "plugin",
+    });
 
-    // 注册会话管理 API
     api.registerHttpRoute({
-      path: '/openclaw-workclaw/sessions',
+      path: "/openclaw-workclaw/sessions",
       handler: createSessionApiHandler(api),
-      auth: 'plugin',
-      match: 'prefix',
-    })
+      auth: "plugin",
+      match: "prefix",
+    });
   },
-}
-
-export function register(api: OpenClawPluginApi): void {
-  plugin.register(api)
-}
-
-export function activate(api: OpenClawPluginApi): void {
-  register(api)
-}
-
-export default plugin
+});

package/openclaw.plugin.json

@@ -1,5 +1,6 @@
 {
   "id": "openclaw-workclaw",
+  "kind": "channel",
   "channels": ["openclaw-workclaw"],
   "skills": ["./skills"],
   "configSchema": {

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@workclaw/openclaw-workclaw",
   "type": "module",
-  "version": "1.0.17",
-  "description": "OpenClaw WorkClaw channel plugin",
-  "license": "MIT",
+  "version": "1.0.18",
+  "description": "openclaw-workclaw channel plugin",
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "openclaw": "^2026.3.13",
+    "openclaw": "2026.4.14",
     "typescript": "^5.6.3"
   },
   "dependencies": {
@@ -16,10 +15,14 @@
     "ws": "^8.19.0",
     "zod": "^4.3.6"
   },
+  "devDependencies": {
+    "@types/node": "^20.0.0"
+  },
   "openclaw": {
     "extensions": [
       "./index.ts"
     ],
+    "setupEntry": "./setup-entry.ts",
     "channel": {
       "id": "openclaw-workclaw",
       "label": "openclaw-workclaw",
@@ -33,6 +36,10 @@
       "order": 35,
       "quickstartAllowFrom": true
     },
+    "compat": {
+      "pluginApi": "2026.4.14",
+      "minGatewayVersion": "2026.4.14"
+    },
     "install": {
       "npmSpec": "@workclaw/openclaw-workclaw",
       "localPath": "extensions/openclaw-workclaw",

package/setup-entry.ts

@@ -0,0 +1,6 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore - types from openclaw 4.2, local dev uses 3.13
+import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core";
+import { workclawPlugin } from "./src/channel.js";
+
+export default defineSetupPluginEntry(workclawPlugin);