openclaw/src/agents/tool-display-config.ts

import type { ToolDisplaySpec as ToolDisplaySpecBase } from "./tool-display-common.js";

export type ToolDisplaySpec = ToolDisplaySpecBase & {
  emoji?: string;
};

export type ToolDisplayConfig = {
  version: number;
  fallback: ToolDisplaySpec;
  tools: Record<string, ToolDisplaySpec>;
};

export const TOOL_DISPLAY_CONFIG: ToolDisplayConfig = {
  version: 1,
  fallback: {
    emoji: "🧩",
    detailKeys: [
      "command",
      "path",
      "url",
      "targetUrl",
      "targetId",
      "ref",
      "element",
      "node",
      "nodeId",
      "id",
      "requestId",
      "to",
      "channelId",
      "guildId",
      "userId",
      "name",
      "query",
      "pattern",
      "messageId",
    ],
  },
  tools: {
    bash: {
      emoji: "🛠️",
      title: "Bash",
      detailKeys: ["command"],
    },
    process: {
      emoji: "🧰",
      title: "Process",
      detailKeys: ["sessionId"],
    },
    read: {
      emoji: "📖",
      title: "Read",
      detailKeys: ["path"],
    },
    write: {
      emoji: "✍️",
      title: "Write",
      detailKeys: ["path"],
    },
    edit: {
      emoji: "📝",
      title: "Edit",
      detailKeys: ["path"],
    },
    attach: {
      emoji: "📎",
      title: "Attach",
      detailKeys: ["path", "url", "fileName"],
    },
    browser: {
      emoji: "🌐",
      title: "Browser",
      actions: {
        status: {
          label: "status",
        },
        start: {
          label: "start",
        },
        stop: {
          label: "stop",
        },
        tabs: {
          label: "tabs",
        },
        open: {
          label: "open",
          detailKeys: ["targetUrl"],
        },
        focus: {
          label: "focus",
          detailKeys: ["targetId"],
        },
        close: {
          label: "close",
          detailKeys: ["targetId"],
        },
        snapshot: {
          label: "snapshot",
          detailKeys: ["targetUrl", "targetId", "ref", "element", "format"],
        },
        screenshot: {
          label: "screenshot",
          detailKeys: ["targetUrl", "targetId", "ref", "element"],
        },
        navigate: {
          label: "navigate",
          detailKeys: ["targetUrl", "targetId"],
        },
        console: {
          label: "console",
          detailKeys: ["level", "targetId"],
        },
        pdf: {
          label: "pdf",
          detailKeys: ["targetId"],
        },
        upload: {
          label: "upload",
          detailKeys: ["paths", "ref", "inputRef", "element", "targetId"],
        },
        dialog: {
          label: "dialog",
          detailKeys: ["accept", "promptText", "targetId"],
        },
        act: {
          label: "act",
          detailKeys: [
            "request.kind",
            "request.ref",
            "request.selector",
            "request.text",
            "request.value",
          ],
        },
      },
    },
    canvas: {
      emoji: "🖼️",
      title: "Canvas",
      actions: {
        present: {
          label: "present",
          detailKeys: ["target", "node", "nodeId"],
        },
        hide: {
          label: "hide",
          detailKeys: ["node", "nodeId"],
        },
        navigate: {
          label: "navigate",
          detailKeys: ["url", "node", "nodeId"],
        },
        eval: {
          label: "eval",
          detailKeys: ["javaScript", "node", "nodeId"],
        },
        snapshot: {
          label: "snapshot",
          detailKeys: ["format", "node", "nodeId"],
        },
        a2ui_push: {
          label: "A2UI push",
          detailKeys: ["jsonlPath", "node", "nodeId"],
        },
        a2ui_reset: {
          label: "A2UI reset",
          detailKeys: ["node", "nodeId"],
        },
      },
    },
    nodes: {
      emoji: "📱",
      title: "Nodes",
      actions: {
        status: {
          label: "status",
        },
        describe: {
          label: "describe",
          detailKeys: ["node", "nodeId"],
        },
        pending: {
          label: "pending",
        },
        approve: {
          label: "approve",
          detailKeys: ["requestId"],
        },
        reject: {
          label: "reject",
          detailKeys: ["requestId"],
        },
        notify: {
          label: "notify",
          detailKeys: ["node", "nodeId", "title", "body"],
        },
        camera_snap: {
          label: "camera snap",
          detailKeys: ["node", "nodeId", "facing", "deviceId"],
        },
        camera_list: {
          label: "camera list",
          detailKeys: ["node", "nodeId"],
        },
        camera_clip: {
          label: "camera clip",
          detailKeys: ["node", "nodeId", "facing", "duration", "durationMs"],
        },
        screen_record: {
          label: "screen record",
          detailKeys: ["node", "nodeId", "duration", "durationMs", "fps", "screenIndex"],
        },
      },
    },
    cron: {
      emoji: "⏰",
      title: "Cron",
      actions: {
        status: {
          label: "status",
        },
        list: {
          label: "list",
        },
        add: {
          label: "add",
          detailKeys: ["job.name", "job.id", "job.schedule", "job.cron"],
        },
        update: {
          label: "update",
          detailKeys: ["id"],
        },
        remove: {
          label: "remove",
          detailKeys: ["id"],
        },
        run: {
          label: "run",
          detailKeys: ["id"],
        },
        runs: {
          label: "runs",
          detailKeys: ["id"],
        },
        wake: {
          label: "wake",
          detailKeys: ["text", "mode"],
        },
      },
    },
    gateway: {
      emoji: "🔌",
      title: "Gateway",
      actions: {
        restart: {
          label: "restart",
          detailKeys: ["reason", "delayMs"],
        },
      },
    },
    whatsapp_login: {
      emoji: "🟢",
      title: "WhatsApp Login",
      actions: {
        start: {
          label: "start",
        },
        wait: {
          label: "wait",
        },
      },
    },
    discord: {
      emoji: "💬",
      title: "Discord",
      actions: {
        react: {
          label: "react",
          detailKeys: ["channelId", "messageId", "emoji"],
        },
        reactions: {
          label: "reactions",
          detailKeys: ["channelId", "messageId"],
        },
        sticker: {
          label: "sticker",
          detailKeys: ["to", "stickerIds"],
        },
        poll: {
          label: "poll",
          detailKeys: ["question", "to"],
        },
        permissions: {
          label: "permissions",
          detailKeys: ["channelId"],
        },
        readMessages: {
          label: "read messages",
          detailKeys: ["channelId", "limit"],
        },
        sendMessage: {
          label: "send",
          detailKeys: ["to", "content"],
        },
        editMessage: {
          label: "edit",
          detailKeys: ["channelId", "messageId"],
        },
        deleteMessage: {
          label: "delete",
          detailKeys: ["channelId", "messageId"],
        },
        threadCreate: {
          label: "thread create",
          detailKeys: ["channelId", "name"],
        },
        threadList: {
          label: "thread list",
          detailKeys: ["guildId", "channelId"],
        },
        threadReply: {
          label: "thread reply",
          detailKeys: ["channelId", "content"],
        },
        pinMessage: {
          label: "pin",
          detailKeys: ["channelId", "messageId"],
        },
        unpinMessage: {
          label: "unpin",
          detailKeys: ["channelId", "messageId"],
        },
        listPins: {
          label: "list pins",
          detailKeys: ["channelId"],
        },
        searchMessages: {
          label: "search",
          detailKeys: ["guildId", "content"],
        },
        memberInfo: {
          label: "member",
          detailKeys: ["guildId", "userId"],
        },
        roleInfo: {
          label: "roles",
          detailKeys: ["guildId"],
        },
        emojiList: {
          label: "emoji list",
          detailKeys: ["guildId"],
        },
        roleAdd: {
          label: "role add",
          detailKeys: ["guildId", "userId", "roleId"],
        },
        roleRemove: {
          label: "role remove",
          detailKeys: ["guildId", "userId", "roleId"],
        },
        channelInfo: {
          label: "channel",
          detailKeys: ["channelId"],
        },
        channelList: {
          label: "channels",
          detailKeys: ["guildId"],
        },
        voiceStatus: {
          label: "voice",
          detailKeys: ["guildId", "userId"],
        },
        eventList: {
          label: "events",
          detailKeys: ["guildId"],
        },
        eventCreate: {
          label: "event create",
          detailKeys: ["guildId", "name"],
        },
        timeout: {
          label: "timeout",
          detailKeys: ["guildId", "userId"],
        },
        kick: {
          label: "kick",
          detailKeys: ["guildId", "userId"],
        },
        ban: {
          label: "ban",
          detailKeys: ["guildId", "userId"],
        },
      },
    },
    exec: {
      emoji: "🛠️",
      title: "Exec",
      detailKeys: ["command"],
    },
    tool_call: {
      emoji: "🧰",
      title: "Tool Call",
      detailKeys: [],
    },
    tool_call_update: {
      emoji: "🧰",
      title: "Tool Call",
      detailKeys: [],
    },
    session_status: {
      emoji: "📊",
      title: "Session Status",
      detailKeys: ["sessionKey", "model"],
    },
    sessions_list: {
      emoji: "🗂️",
      title: "Sessions",
      detailKeys: ["kinds", "limit", "activeMinutes", "messageLimit"],
    },
    sessions_send: {
      emoji: "📨",
      title: "Session Send",
      detailKeys: ["label", "sessionKey", "agentId", "timeoutSeconds"],
    },
    sessions_history: {
      emoji: "🧾",
      title: "Session History",
      detailKeys: ["sessionKey", "limit", "includeTools"],
    },
    sessions_spawn: {
      emoji: "🧑‍🔧",
      title: "Sub-agent",
      detailKeys: ["label", "task", "agentId", "model", "thinking", "runTimeoutSeconds", "cleanup"],
    },
    subagents: {
      emoji: "🤖",
      title: "Subagents",
      actions: {
        list: {
          label: "list",
          detailKeys: ["recentMinutes"],
        },
        kill: {
          label: "kill",
          detailKeys: ["target"],
        },
        steer: {
          label: "steer",
          detailKeys: ["target"],
        },
      },
    },
    agents_list: {
      emoji: "🧭",
      title: "Agents",
      detailKeys: [],
    },
    memory_search: {
      emoji: "🧠",
      title: "Memory Search",
      detailKeys: ["query"],
    },
    memory_get: {
      emoji: "📓",
      title: "Memory Get",
      detailKeys: ["path", "from", "lines"],
    },
    web_search: {
      emoji: "🔎",
      title: "Web Search",
      detailKeys: ["query", "count"],
    },
    web_fetch: {
      emoji: "📄",
      title: "Web Fetch",
      detailKeys: ["url", "extractMode", "maxChars"],
    },
    code_execution: {
      emoji: "🧮",
      title: "Code Execution",
      detailKeys: ["task"],
    },
    message: {
      emoji: "✉️",
      title: "Message",
      actions: {
        send: {
          label: "send",
          detailKeys: ["provider", "to", "media", "replyTo", "threadId"],
        },
        poll: {
          label: "poll",
          detailKeys: ["provider", "to", "pollQuestion"],
        },
        react: {
          label: "react",
          detailKeys: ["provider", "to", "messageId", "emoji", "remove"],
        },
        reactions: {
          label: "reactions",
          detailKeys: ["provider", "to", "messageId", "limit"],
        },
        read: {
          label: "read",
          detailKeys: ["provider", "to", "limit"],
        },
        edit: {
          label: "edit",
          detailKeys: ["provider", "to", "messageId"],
        },
        delete: {
          label: "delete",
          detailKeys: ["provider", "to", "messageId"],
        },
        pin: {
          label: "pin",
          detailKeys: ["provider", "to", "messageId"],
        },
        unpin: {
          label: "unpin",
          detailKeys: ["provider", "to", "messageId"],
        },
        "list-pins": {
          label: "list pins",
          detailKeys: ["provider", "to"],
        },
        permissions: {
          label: "permissions",
          detailKeys: ["provider", "channelId", "to"],
        },
        "thread-create": {
          label: "thread create",
          detailKeys: ["provider", "channelId", "threadName"],
        },
        "thread-list": {
          label: "thread list",
          detailKeys: ["provider", "guildId", "channelId"],
        },
        "thread-reply": {
          label: "thread reply",
          detailKeys: ["provider", "channelId", "messageId"],
        },
        search: {
          label: "search",
          detailKeys: ["provider", "guildId", "query"],
        },
        sticker: {
          label: "sticker",
          detailKeys: ["provider", "to", "stickerId"],
        },
        "member-info": {
          label: "member",
          detailKeys: ["provider", "guildId", "userId"],
        },
        "role-info": {
          label: "roles",
          detailKeys: ["provider", "guildId"],
        },
        "emoji-list": {
          label: "emoji list",
          detailKeys: ["provider", "guildId"],
        },
        "emoji-upload": {
          label: "emoji upload",
          detailKeys: ["provider", "guildId", "emojiName"],
        },
        "sticker-upload": {
          label: "sticker upload",
          detailKeys: ["provider", "guildId", "stickerName"],
        },
        "role-add": {
          label: "role add",
          detailKeys: ["provider", "guildId", "userId", "roleId"],
        },
        "role-remove": {
          label: "role remove",
          detailKeys: ["provider", "guildId", "userId", "roleId"],
        },
        "channel-info": {
          label: "channel",
          detailKeys: ["provider", "channelId"],
        },
        "channel-list": {
          label: "channels",
          detailKeys: ["provider", "guildId"],
        },
        "voice-status": {
          label: "voice",
          detailKeys: ["provider", "guildId", "userId"],
        },
        "event-list": {
          label: "events",
          detailKeys: ["provider", "guildId"],
        },
        "event-create": {
          label: "event create",
          detailKeys: ["provider", "guildId", "eventName"],
        },
        timeout: {
          label: "timeout",
          detailKeys: ["provider", "guildId", "userId"],
        },
        kick: {
          label: "kick",
          detailKeys: ["provider", "guildId", "userId"],
        },
        ban: {
          label: "ban",
          detailKeys: ["provider", "guildId", "userId"],
        },
      },
    },
    apply_patch: {
      emoji: "🩹",
      title: "Apply Patch",
      detailKeys: [],
    },
    image: {
      emoji: "🖼️",
      title: "Image",
      detailKeys: ["path", "paths", "url", "urls", "prompt", "model"],
    },
    image_generate: {
      emoji: "🎨",
      title: "Image Generation",
      actions: {
        generate: {
          label: "generate",
          detailKeys: ["prompt", "model", "count", "resolution", "aspectRatio"],
        },
        list: {
          label: "list",
          detailKeys: ["provider", "model"],
        },
      },
    },
    pdf: {
      emoji: "📑",
      title: "PDF",
      detailKeys: ["path", "paths", "url", "urls", "prompt", "pageRange", "model"],
    },
    sessions_yield: {
      emoji: "⏸️",
      title: "Yield",
      detailKeys: ["message"],
    },
    tts: {
      emoji: "🔊",
      title: "TTS",
      detailKeys: ["text", "channel"],
    },
  },
};

export function serializeToolDisplayConfig(
  config: ToolDisplayConfig = TOOL_DISPLAY_CONFIG,
): string {
  return `${JSON.stringify(config, null, 2)}\n`;
}