@zeyiy/openclaw-channel 0.3.4 → 0.3.6

package/README.md

@@ -14,6 +14,9 @@ Chinese documentation: [README.zh-CN.md](https://github.com/ZeyiY/openclaw-chann
 - Quote/reply message parsing for inbound context
 - Multi-account login via `channels.openim.accounts.<id>`
 - Group trigger policy with optional mention-only mode
+- Auto read-receipt for direct messages
+- Per-user session isolation (direct chat) / shared session (group chat)
+- Agent Portal Bridge — persistent WebSocket connection to agent-portal cloud service
 - Interactive setup command: `openclaw openim setup`
 
 ## Installation
@@ -58,7 +61,9 @@ openclaw openim setup
           "enabled": true,
           "token": "your_token",
           "wsAddr": "ws://127.0.0.1:10001",
-          "apiAddr": "http://127.0.0.1:10002"
+          "apiAddr": "http://127.0.0.1:10002",
+          "botId": "my-bot-001",
+          "portalWsAddr": "wss://portal.example.com/ws"
         }
       }
     }
@@ -75,6 +80,8 @@ If set, only these users can trigger processing:
 - direct messages to the account
 - group messages where they `@` the account
 
+`botId` and `portalWsAddr` are optional. When both are set, the plugin establishes a WebSocket connection to the agent-portal cloud service, enabling remote management of agents, files, and models.
+
 Single-account fallback (without `accounts`) is supported.
 
 Environment fallback is supported for the `default` account:
@@ -113,6 +120,27 @@ Optional env overrides:
   - `name` (optional): override filename for URL input
   - `accountId` (optional): select sending account
 
+## Agent Portal Bridge
+
+When `botId` and `portalWsAddr` are configured, the plugin connects to the agent-portal cloud service via WebSocket. The portal can remotely invoke the following methods:
+
+| Method | Description |
+|---|---|
+| `bot.agent.get` | Resolve the agentId bound to the current bot |
+| `models.list` | List available models from config |
+| `agents.list` | List all configured agents |
+| `agents.create` | Create a new agent with workspace |
+| `agents.files.list` | List workspace files for an agent |
+| `agents.files.get` | Read a single workspace file |
+| `agents.files.set` | Write a file to agent workspace |
+| `tools.catalog` | List available tools |
+| `skills.status` | List installed skills/plugins status |
+| `skills.search` | Search ClawHub for skills (placeholder) |
+| `skills.detail` | Get detail for a specific skill |
+| `cron.list` | List configured cron jobs |
+
+The connection features automatic reconnect with exponential backoff and heartbeat keepalive.
+
 ## Development
 
 ```bash

package/README.zh-CN.md

@@ -14,6 +14,9 @@ English documentation: [README.md](https://github.com/ZeyiY/openclaw-channel/blo
 - 支持引用消息解析（用于入站上下文）
 - 支持多账号并发（`channels.openim.accounts.<id>`）
 - 支持群聊仅 @ 触发
+- 私聊消息自动标记已读（已读回执）
+- 每用户独立会话（私聊）/ 同群共享会话（群聊）
+- Agent Portal Bridge — 与 agent-portal 云服务保持 WebSocket 长连接，支持远程管理
 - 提供交互式配置命令：`openclaw openim setup`
 
 ## 安装
@@ -58,7 +61,9 @@ openclaw openim setup
           "enabled": true,
           "token": "your_token",
           "wsAddr": "ws://127.0.0.1:10001",
-          "apiAddr": "http://127.0.0.1:10002"
+          "apiAddr": "http://127.0.0.1:10002",
+          "botId": "my-bot-001",
+          "portalWsAddr": "wss://portal.example.com/ws"
         }
       }
     }
@@ -74,6 +79,8 @@ openclaw openim setup
 - 给账号发单聊消息
 - 在群里 @ 账号的消息
 
+`botId` 和 `portalWsAddr` 为可选项。同时配置后，插件会与 agent-portal 云服务建立 WebSocket 连接，支持远程管理 agent、文件和模型。
+
 支持单账号兜底写法（不使用 `accounts`）。
 
 `default` 账号支持环境变量兜底：
@@ -112,6 +119,27 @@ openclaw openim setup
   - `name`（可选）：URL 输入时覆盖文件名
   - `accountId`（可选）：指定发送账号
 
+## Agent Portal Bridge
+
+配置 `botId` 和 `portalWsAddr` 后，插件会通过 WebSocket 连接到 agent-portal 云服务。Portal 可远程调用以下方法：
+
+| 方法 | 说明 |
+|---|---|
+| `bot.agent.get` | 获取当前 bot 绑定的 agentId |
+| `models.list` | 列出配置中的可用模型 |
+| `agents.list` | 列出所有已配置的 agent |
+| `agents.create` | 创建新 agent 及工作空间 |
+| `agents.files.list` | 列出 agent 工作空间文件 |
+| `agents.files.get` | 读取单个工作空间文件 |
+| `agents.files.set` | 写入文件到 agent 工作空间 |
+| `tools.catalog` | 列出可用工具 |
+| `skills.status` | 列出已安装技能/插件状态 |
+| `skills.search` | 搜索 ClawHub 技能（占位） |
+| `skills.detail` | 获取特定技能详情 |
+| `cron.list` | 列出已配置的定时任务 |
+
+连接支持指数退避自动重连和心跳保活。
+
 ## 开发
 
 ```bash

package/dist/portal.js

@@ -207,26 +207,24 @@ async function handleAgentsFilesList(api, params) {
     for (const name of AGENT_FILE_NAMES) {
         const filePath = join(workspaceDir, name);
         const meta = await statFileSafely(filePath);
-        if (meta) {
-            let content;
-            try {
-                content = await readFile(filePath, "utf-8");
-            }
-            catch {
-                // skip unreadable files
-            }
-            files.push({
-                name,
-                path: filePath,
-                missing: false,
-                size: meta.size,
-                updatedAtMs: meta.updatedAtMs,
-                content,
-            });
+        if (!meta)
+            continue;
+        let content;
+        try {
+            content = await readFile(filePath, "utf-8");
         }
-        else {
-            files.push({ name, path: filePath, missing: true });
+        catch {
+            // skip unreadable files
+            continue;
         }
+        files.push({
+            name,
+            path: filePath,
+            missing: false,
+            size: meta.size,
+            updatedAtMs: meta.updatedAtMs,
+            content,
+        });
     }
     portalLog(api, "info", `agents.files.list: agentId=${agentId} workspace=${workspaceDir} found=${files.filter(f => !f.missing).length}`);
     return { agentId, workspace: workspaceDir, files };
@@ -350,15 +348,191 @@ async function handleAgentsCreate(api, params) {
     portalLog(api, "info", `agents.create: agentId=${agentId} name=${rawName} workspace=${workspaceDir}`);
     return { ok: true, agentId, name: rawName, workspace: workspaceDir };
 }
+/**
+ * bot.agent.get — resolve the agentId bound to the current bot connection.
+ *
+ * Lookup order:
+ * 1. Config bindings: match channel=openim + accountId
+ * 2. Fallback to default agent
+ */
+function handleBotAgentGet(api, accountId) {
+    const cfg = getConfig(api);
+    const agents = Array.isArray(cfg.agents?.list) ? cfg.agents.list : [];
+    // 1. Check bindings
+    const bindings = Array.isArray(cfg.bindings) ? cfg.bindings : [];
+    for (const b of bindings) {
+        if (b?.match?.channel === "openim" &&
+            b?.match?.accountId === accountId &&
+            b?.agentId) {
+            const agentId = normalizeAgentId(b.agentId);
+            const entry = agents.find((a) => a?.id && normalizeAgentId(a.id) === agentId);
+            return { agentId, ...(entry?.name ? { name: entry.name } : {}) };
+        }
+    }
+    // 2. Fallback to default agent
+    const defaultId = resolveDefaultAgentId(cfg);
+    const defaultEntry = agents.find((a) => a?.id && normalizeAgentId(a.id) === defaultId);
+    return { agentId: defaultId, ...(defaultEntry?.name ? { name: defaultEntry.name } : {}) };
+}
+/**
+ * tools.catalog — return the runtime tool catalog from config.
+ * Reads tools from agents' TOOLS.md references and registered plugin tools.
+ */
+function handleToolsCatalog(api) {
+    const cfg = getConfig(api);
+    const tools = [];
+    // Core tools from config.tools section
+    const configTools = cfg.tools;
+    if (configTools && typeof configTools === "object") {
+        for (const [name, toolCfg] of Object.entries(configTools)) {
+            if (!name || name.startsWith("_"))
+                continue;
+            tools.push({
+                name,
+                description: toolCfg?.description ?? "",
+                source: "core",
+                optional: Boolean(toolCfg?.optional),
+            });
+        }
+    }
+    // Plugin-registered tools (from channel registrations)
+    const plugins = cfg.plugins;
+    if (plugins && typeof plugins === "object") {
+        for (const [pluginId, pluginCfg] of Object.entries(plugins)) {
+            if (!pluginId)
+                continue;
+            const pluginTools = pluginCfg?.tools;
+            if (Array.isArray(pluginTools)) {
+                for (const t of pluginTools) {
+                    const tName = typeof t === "string" ? t : t?.name;
+                    if (!tName)
+                        continue;
+                    tools.push({
+                        name: String(tName),
+                        description: typeof t === "object" ? t?.description ?? "" : "",
+                        source: "plugin",
+                        pluginId,
+                        optional: typeof t === "object" ? Boolean(t?.optional) : false,
+                    });
+                }
+            }
+        }
+    }
+    // Also include OpenIM channel tools registered by this plugin
+    const openimTools = ["openim_send_text", "openim_send_image", "openim_send_file", "openim_send_video"];
+    for (const name of openimTools) {
+        tools.push({ name, description: `OpenIM: ${name.replace("openim_", "")}`, source: "plugin", pluginId: "openim" });
+    }
+    return { tools };
+}
+/**
+ * skills.status — return the visible skill list for an agent.
+ * Reads installed plugins/skills from config and reports their status.
+ */
+function handleSkillsStatus(api, params) {
+    const cfg = getConfig(api);
+    const skills = [];
+    // Plugins as skills
+    const plugins = cfg.plugins;
+    if (plugins && typeof plugins === "object") {
+        for (const [pluginId, pluginCfg] of Object.entries(plugins)) {
+            if (!pluginId)
+                continue;
+            const enabled = pluginCfg?.enabled !== false;
+            skills.push({
+                name: pluginId,
+                description: pluginCfg?.description ?? "",
+                installed: true,
+                enabled,
+                configCheck: enabled ? "ok" : "missing",
+            });
+        }
+    }
+    // Channels as skills
+    const channels = cfg.channels;
+    if (channels && typeof channels === "object") {
+        for (const [chanId, chanCfg] of Object.entries(channels)) {
+            if (!chanId)
+                continue;
+            skills.push({
+                name: `channel:${chanId}`,
+                description: `Channel: ${chanId}`,
+                installed: true,
+                enabled: chanCfg?.enabled !== false,
+                configCheck: "ok",
+            });
+        }
+    }
+    return { skills };
+}
+/**
+ * skills.search — search ClawHub for discoverable skills.
+ * Currently returns an empty list (ClawHub integration not yet implemented locally).
+ */
+function handleSkillsSearch(_api, params) {
+    // ClawHub discovery requires network access to the registry — placeholder for now
+    return { skills: [] };
+}
+/**
+ * skills.detail — get detail for a specific skill from ClawHub.
+ * Placeholder: returns basic info from local config if the skill is installed.
+ */
+function handleSkillsDetail(api, params) {
+    const name = String(params.name ?? "").trim();
+    if (!name)
+        throw { code: 400, message: "name is required" };
+    const cfg = getConfig(api);
+    const plugins = cfg.plugins;
+    if (plugins && typeof plugins === "object" && name in plugins) {
+        const p = plugins[name];
+        return {
+            skill: {
+                name,
+                description: p?.description ?? "",
+                author: p?.author ?? undefined,
+                version: p?.version ?? undefined,
+                source: "local",
+            },
+        };
+    }
+    return { skill: null };
+}
+/**
+ * cron.list — return configured cron jobs.
+ */
+function handleCronList(api) {
+    const cfg = getConfig(api);
+    const jobs = [];
+    const cronConfig = cfg.cron ?? cfg.automation?.cron;
+    if (Array.isArray(cronConfig)) {
+        for (const entry of cronConfig) {
+            if (!entry || typeof entry !== "object")
+                continue;
+            jobs.push({
+                id: String(entry.id ?? entry.name ?? `cron-${jobs.length}`),
+                name: entry.name ?? entry.id ?? undefined,
+                schedule: String(entry.schedule ?? entry.cron ?? ""),
+                command: entry.command ?? entry.text ?? entry.message ?? undefined,
+                enabled: entry.enabled !== false,
+                lastRun: entry.lastRun ?? undefined,
+                nextRun: entry.nextRun ?? undefined,
+            });
+        }
+    }
+    return { jobs };
+}
 // ---------------------------------------------------------------------------
 // Request dispatch
 // ---------------------------------------------------------------------------
-async function handlePortalRequest(api, request) {
+async function handlePortalRequest(api, accountId, request) {
     const { id, method, params } = request;
-    portalLog(api, "info", `request received: id=${id} method=${method} params=${JSON.stringify(params)}`);
+    portalLog(api, "info", `request received: id=${id} method=${method} params=${JSON.stringify(params)} accountId=${accountId}`);
     try {
         let result;
         switch (method) {
+            case "bot.agent.get":
+                result = handleBotAgentGet(api, accountId);
+                break;
             case "models.list":
                 result = handleModelsList(api, params ?? {});
                 break;
@@ -377,6 +551,21 @@ async function handlePortalRequest(api, request) {
             case "agents.create":
                 result = await handleAgentsCreate(api, params ?? {});
                 break;
+            case "tools.catalog":
+                result = handleToolsCatalog(api);
+                break;
+            case "skills.status":
+                result = handleSkillsStatus(api, params ?? {});
+                break;
+            case "skills.search":
+                result = handleSkillsSearch(api, params ?? {});
+                break;
+            case "skills.detail":
+                result = handleSkillsDetail(api, params ?? {});
+                break;
+            case "cron.list":
+                result = handleCronList(api);
+                break;
             case "ping":
                 result = { pong: true };
                 break;
@@ -451,7 +640,7 @@ function connectPortal(api, bridge) {
             portalLog(api, "warn", `malformed request from portal: missing id or method`);
             return;
         }
-        const response = await handlePortalRequest(api, request);
+        const response = await handlePortalRequest(api, bridge.accountId, request);
         sendResponse(ws, response);
         portalLog(api, "debug", `response sent: id=${request.id} method=${request.method} ok=${!response.error}`);
     });

package/dist/types.d.ts

@@ -39,7 +39,38 @@ export interface InboundBodyResult {
     kind: "text" | "image" | "video" | "file" | "mixed" | "unknown";
     media?: InboundMediaItem[];
 }
-export type PortalMethod = "models.list" | "agents.list" | "agents.files.list" | "agents.files.get" | "agents.files.set" | "agents.create" | "ping";
+export type PortalMethod = "bot.agent.get" | "models.list" | "agents.list" | "agents.files.list" | "agents.files.get" | "agents.files.set" | "agents.create" | "tools.catalog" | "skills.status" | "skills.search" | "skills.detail" | "cron.list" | "ping";
+export interface ToolCatalogEntry {
+    name: string;
+    description?: string;
+    source: "core" | "plugin";
+    pluginId?: string;
+    optional?: boolean;
+}
+export interface SkillStatusEntry {
+    name: string;
+    description?: string;
+    installed: boolean;
+    enabled: boolean;
+    configCheck?: "ok" | "missing" | "invalid";
+    missingRequirements?: string[];
+}
+export interface SkillSearchEntry {
+    name: string;
+    description?: string;
+    author?: string;
+    version?: string;
+    source: string;
+}
+export interface CronJobEntry {
+    id: string;
+    name?: string;
+    schedule: string;
+    command?: string;
+    enabled: boolean;
+    lastRun?: number;
+    nextRun?: number;
+}
 export interface PortalRequest {
     id: string;
     method: PortalMethod;

package/openclaw.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "openclaw-channel",
   "name": "OpenIM Channel",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "OpenIM protocol channel for OpenClaw",
   "author": "ZeyiY",
   "channels": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeyiy/openclaw-channel",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "OpenIM channel plugin for OpenClaw gateway (fork of @openim/openclaw-channel)",
   "license": "AGPL-3.0-only",
   "author": "ZeyiY",