clawpet-plugins 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# ClawPet Plugin for OpenClaw 🦞
+
+自动上报 Agent tool call 到 ClawPet，驱动龙虾实时动画。
+
+## 安装
+
+```bash
+openclaw plugins install clawpet-plugins
+```
+
+## 配置
+
+在 OpenClaw 配置中设置 apiKey：
+
+```json
+{
+  "plugins": {
+    "entries": {
+      "clawpet-plugins": {
+        "enabled": true,
+        "config": {
+          "apiKey": "你的 ClawPet API Key"
+        }
+      }
+    }
+  }
+}
+```
+
+重启 gateway 生效。
+
+## 功能
+
+- 每次 tool call 自动上报
+- 异步执行，不影响 agent 性能
+- 失败静默，不中断正常工作

package/index.ts

@@ -0,0 +1,184 @@
+/**
+ * ClawPet OpenClaw Plugin
+ *
+ * 自动上报 agent 的 tool call 到 ClawPet 后端，
+ * 驱动龙虾宠物实时动画。
+ *
+ * Hook:
+ * - after_tool_call: 每次 tool 执行完毕后上报 action + summary
+ * - agent_end: 每轮对话结束时上报
+ *
+ * 配置（在 OpenClaw config 的 plugins.entries 段）：
+ * {
+ *   "clawpet-plugins": {
+ *     "enabled": true,
+ *     "config": {
+ *       "apiKey": "cpk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+ *       "apiBase": "https://api.venusx.top"
+ *     }
+ *   }
+ * }
+ */
+
+// ---------------------------------------------------------------------------
+// 类型定义（对齐 OpenClaw Plugin API，不依赖源码 import）
+// ---------------------------------------------------------------------------
+
+type PluginLogger = {
+  debug?: (message: string) => void;
+  info: (message: string) => void;
+  warn: (message: string) => void;
+  error: (message: string) => void;
+};
+
+type PluginApi = {
+  id: string;
+  name: string;
+  pluginConfig?: Record<string, unknown>;
+  logger: PluginLogger;
+  on: (
+    hookName: string,
+    handler: (event: any, ctx: any) => void | Promise<void>,
+    opts?: { priority?: number },
+  ) => void;
+};
+
+// ---------------------------------------------------------------------------
+// 常量
+// ---------------------------------------------------------------------------
+
+/** 默认 API 地址 */
+const DEFAULT_API_BASE = "https://api.venusx.top";
+
+/** 去重窗口（ms）—— 同一工具 2 秒内不重复上报 */
+const DEDUP_WINDOW = 2000;
+
+/** 上报超时（ms） */
+const REPORT_TIMEOUT = 5000;
+
+// ---------------------------------------------------------------------------
+// 插件入口
+// ---------------------------------------------------------------------------
+
+export default {
+  register(api: PluginApi) {
+    const config = api.pluginConfig as
+      | { apiKey?: string; apiBase?: string }
+      | undefined;
+    const apiKey = config?.apiKey;
+    let apiBase = config?.apiBase || DEFAULT_API_BASE;
+
+    if (!apiKey) {
+      api.logger.warn(
+        "[ClawPet] No apiKey configured — plugin disabled. " +
+          "Set plugins.entries.clawpet-plugins.config.apiKey in your OpenClaw config.",
+      );
+      return;
+    }
+
+    if (!apiKey.startsWith("cpk_")) {
+      api.logger.warn(
+        "[ClawPet] apiKey should start with 'cpk_' — check your config.",
+      );
+      return;
+    }
+
+    api.logger.info(`[ClawPet] Plugin active, reporting to ${apiBase}`);
+
+    // 去重：记录最近上报的 toolName → timestamp
+    const lastReported = new Map<string, number>();
+
+    /**
+     * 异步上报到 ClawPet 后端
+     * 不 await，不阻塞 agent
+     */
+    function reportActivity(action: string, summary: string): void {
+      // 去重检查
+      const now = Date.now();
+      const lastTime = lastReported.get(action);
+      if (lastTime && now - lastTime < DEDUP_WINDOW) return;
+      lastReported.set(action, now);
+
+      // 清理过期去重记录（防内存泄漏）
+      if (lastReported.size > 100) {
+        for (const [key, ts] of lastReported) {
+          if (now - ts > DEDUP_WINDOW * 5) lastReported.delete(key);
+        }
+      }
+
+      // 异步 POST，fire-and-forget
+      const controller = new AbortController();
+      const timeout = setTimeout(() => controller.abort(), REPORT_TIMEOUT);
+
+      fetch(`${apiBase}/webhook`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${apiKey}`,
+        },
+        body: JSON.stringify({ action, summary }),
+        signal: controller.signal,
+      })
+        .then(async (res) => {
+          clearTimeout(timeout);
+          if (res.ok) {
+            try {
+              const data = await res.json();
+              // 搭便车更新 apiBase
+              if (data?.config?.apiBase && data.config.apiBase !== apiBase) {
+                api.logger.info(
+                  `[ClawPet] API base updated: ${apiBase} → ${data.config.apiBase}`,
+                );
+                apiBase = data.config.apiBase;
+              }
+            } catch {
+              // JSON 解析失败，忽略
+            }
+          }
+        })
+        .catch(() => {
+          clearTimeout(timeout);
+          // 上报失败静默忽略，不影响 agent 工作
+        });
+    }
+
+    // ========================================
+    // Hook: after_tool_call
+    // 每次 tool 执行完毕后上报
+    // ========================================
+
+    api.on("after_tool_call", (event: any) => {
+      try {
+        if (!event) return;
+        const { toolName, durationMs, error } = event;
+        if (!toolName) return;
+
+        const summary = error
+          ? `${toolName} failed (${durationMs ?? 0}ms)`
+          : `${toolName} (${durationMs ?? 0}ms)`;
+
+        reportActivity(toolName, summary);
+      } catch {
+        // Hook 内部错误静默，绝不影响 agent
+      }
+    });
+
+    // ========================================
+    // Hook: agent_end
+    // Agent 一轮结束时上报
+    // ========================================
+
+    api.on("agent_end", (event: any) => {
+      try {
+        if (!event) return;
+        if (event.success) {
+          reportActivity("idle", `Turn complete (${event.durationMs ?? 0}ms)`);
+        } else {
+          reportActivity("error", `Turn failed: ${event.error ?? "unknown"}`);
+        }
+      } catch {
+        // Hook 内部错误静默，绝不影响 agent
+      }
+    });
+  },
+};

package/openclaw.plugin.json

@@ -0,0 +1,21 @@
+{
+  "id": "clawpet-plugins",
+  "name": "ClawPet",
+  "description": "Auto-report agent tool calls to ClawPet for real-time lobster visualization.",
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "apiBase": {
+        "type": "string",
+        "description": "ClawPet API base URL",
+        "default": "https://api.venusx.top"
+      },
+      "apiKey": {
+        "type": "string",
+        "description": "ClawPet API key (cpk_xxx)"
+      }
+    },
+    "required": []
+  }
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "clawpet-plugins",
+  "version": "1.0.0",
+  "description": "OpenClaw plugin for ClawPet — auto-report tool calls for real-time pet visualization",
+  "type": "module",
+  "main": "index.ts",
+  "license": "MIT",
+  "keywords": ["openclaw", "openclaw-plugin", "clawpet", "pet", "visualization"],
+  "files": [
+    "index.ts",
+    "openclaw.plugin.json",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ronin-storm/claw-pet",
+    "directory": "plugin"
+  },
+  "homepage": "https://myclawpet.com",
+  "publishConfig": {
+    "access": "public"
+  },
+  "openclaw": {
+    "extensions": [
+      "./index.ts"
+    ]
+  }
+}