​

Tools (Clawdbot)

​

Disabling tools

{
  tools: { deny: ["browser"] }
}

​

Tool profiles (base allowlist)

• minimal: session_status only
• coding: group:fs, group:runtime, group:sessions, group:memory, image
• messaging: group:messaging, sessions_list, sessions_history, sessions_send, session_status
• full: no restriction (same as unset)

{
  tools: {
    profile: "messaging",
    allow: ["slack", "discord"]
  }
}

{
  tools: {
    profile: "coding",
    deny: ["group:runtime"]
  }
}

{
  tools: { profile: "coding" },
  agents: {
    list: [
      {
        id: "support",
        tools: { profile: "messaging", allow: ["slack"] }
      }
    ]
  }
}

​

Tool groups (shorthands)

• group:runtime: exec, bash, process
• group:fs: read, write, edit, apply_patch
• group:sessions: sessions_list, sessions_history, sessions_send, sessions_spawn, session_status
• group:memory: memory_search, memory_get
• group:ui: browser, canvas
• group:automation: cron, gateway
• group:messaging: message
• group:nodes: nodes
• group:clawdbot: all built-in Clawdbot tools (excludes provider plugins)

{
  tools: {
    allow: ["group:fs", "browser"]
  }
}

​

Plugins + tools

​

Tool inventory

​

apply_patch

​

exec

• command (required)
• yieldMs (auto-background after timeout, default 10000)
• background (immediate background)
• timeout (seconds; kills the process if exceeded, default 1800)
• elevated (bool; run on host if elevated mode is enabled/allowed; only changes behavior when the agent is sandboxed)
• Need a real TTY? Use the tmux skill.

• Returns status: "running" with a sessionId when backgrounded.
• Use process to poll/log/write/kill/clear background sessions.
• If process is disallowed, exec runs synchronously and ignores yieldMs/background.
• elevated is gated by tools.elevated plus any agents.list[].tools.elevated override (both must allow) and runs on the host.
• elevated only changes behavior when the agent is sandboxed (otherwise it’s a no-op).

​

process

• list, poll, log, write, kill, clear, remove

• poll returns new output and exit status when complete.
• log supports line-based offset/limit (omit offset to grab the last N lines).
• process is scoped per agent; sessions from other agents are not visible.

​

browser

• status, start, stop, tabs, open, focus, close
• snapshot (aria/ai)
• screenshot (returns image block + MEDIA:<path>)
• act (UI actions: click/type/press/hover/drag/select/fill/resize/wait/evaluate)
• navigate, console, pdf, upload, dialog

• profiles — list all browser profiles with status
• create-profile — create new profile with auto-allocated port (or cdpUrl)
• delete-profile — stop browser, delete user data, remove from config (local only)
• reset-profile — kill orphan process on profile’s port (local only)

• controlUrl (defaults from config)
• profile (optional; defaults to browser.defaultProfile) Notes:
• Requires browser.enabled=true (default is true; set false to disable).
• Uses browser.controlUrl unless controlUrl is passed explicitly.
• All actions accept optional profile parameter for multi-instance support.
• When profile is omitted, uses browser.defaultProfile (defaults to “clawd”).
• Profile names: lowercase alphanumeric + hyphens only (max 64 chars).
• Port range: 18800-18899 (~100 profiles max).
• Remote profiles are attach-only (no start/stop/reset).
• snapshot defaults to ai when Playwright is installed; use aria for the accessibility tree.
• snapshot also supports role-snapshot options (interactive, compact, depth, selector) which return refs like e12.
• act requires ref from snapshot (numeric 12 from AI snapshots, or e12 from role snapshots); use evaluate for rare CSS selector needs.
• Avoid act → wait by default; use it only in exceptional cases (no reliable UI state to wait on).
• upload can optionally pass a ref to auto-click after arming.
• upload also supports inputRef (aria ref) or element (CSS selector) to set <input type="file"> directly.

​

canvas

• present, hide, navigate, eval
• snapshot (returns image block + MEDIA:<path>)
• a2ui_push, a2ui_reset

• Uses gateway node.invoke under the hood.
• If no node is provided, the tool picks a default (single connected node or local mac node).
• A2UI is v0.8 only (no createSurface); the CLI rejects v0.9 JSONL with line errors.
• Quick smoke: clawdbot nodes canvas a2ui push --node <id> --text "Hello from A2UI".

​

nodes

• status, describe
• pending, approve, reject (pairing)
• notify (macOS system.notify)
• run (macOS system.run)
• camera_snap, camera_clip, screen_record
• location_get

• Camera/screen commands require the node app to be foregrounded.
• Images return image blocks + MEDIA:<path>.
• Videos return FILE:<path> (mp4).
• Location returns a JSON payload (lat/lon/accuracy/timestamp).
• run params: command argv array; optional cwd, env (KEY=VAL), commandTimeoutMs, invokeTimeoutMs, needsScreenRecording.

{
  "action": "run",
  "node": "office-mac",
  "command": ["echo", "Hello"],
  "env": ["FOO=bar"],
  "commandTimeoutMs": 12000,
  "invokeTimeoutMs": 45000,
  "needsScreenRecording": false
}

​

image

• image (required path or URL)
• prompt (optional; defaults to “Describe the image.”)
• model (optional override)
• maxBytesMb (optional size cap)

• Only available when agents.defaults.imageModel is configured (primary or fallbacks), or when an implicit image model can be inferred from your default model + configured auth (best-effort pairing).
• Uses the image model directly (independent of the main chat model).

​

message

• send (text + optional media)
• poll (WhatsApp/Discord/MS Teams polls)
• react / reactions / read / edit / delete
• pin / unpin / list-pins
• permissions
• thread-create / thread-list / thread-reply
• search
• sticker
• member-info / role-info
• emoji-list / emoji-upload / sticker-upload
• role-add / role-remove
• channel-info / channel-list
• voice-status
• event-list / event-create
• timeout / kick / ban

• send routes WhatsApp via the Gateway; other channels go direct.
• poll uses the Gateway for WhatsApp and MS Teams; Discord polls go direct.
• When a message tool call is bound to an active chat session, sends are constrained to that session’s target to avoid cross-context leaks.

​

cron

• status, list
• add, update, remove, run, runs
• wake (enqueue system event + optional immediate heartbeat)

• add expects a full cron job object (same schema as cron.add RPC).
• update uses { id, patch }.

​

gateway

• restart (sends SIGUSR1 to the current process; clawdbot gateway restart in-place)
• config.get / config.schema
• config.apply (validate + write config + restart + wake)
• update.run (run update + restart + wake)

• Use delayMs (defaults to 2000) to avoid interrupting an in-flight reply.
• restart is disabled by default; enable with commands.restart: true.

​

sessions_list / sessions_history / sessions_send / sessions_spawn / session_status

• sessions_list: kinds?, limit?, activeMinutes?, messageLimit? (0 = none)
• sessions_history: sessionKey, limit?, includeTools?
• sessions_send: sessionKey, message, timeoutSeconds? (0 = fire-and-forget)
• sessions_spawn: task, label?, agentId?, model?, runTimeoutSeconds?, cleanup?
• session_status: sessionKey? (default current), model? (default clears override)

• main is the canonical direct-chat key; global/unknown are hidden.
• messageLimit > 0 fetches last N messages per session (tool messages filtered).
• sessions_send waits for final completion when timeoutSeconds > 0.
• Delivery/announce happens after completion and is best-effort; status: "ok" confirms the agent run finished, not that the announce was delivered.
• sessions_spawn starts a sub-agent run and posts an announce reply back to the requester chat.
• sessions_spawn is non-blocking and returns status: "accepted" immediately.
• sessions_send runs a reply‑back ping‑pong (reply REPLY_SKIP to stop; max turns via session.agentToAgent.maxPingPongTurns, 0–5).
• After the ping‑pong, the target agent runs an announce step; reply ANNOUNCE_SKIP to suppress the announcement.

​

agents_list

• Result is restricted to per-agent allowlists (agents.list[].subagents.allowAgents).
• When ["*"] is configured, the tool includes all configured agents and marks allowAny: true.

​

Parameters (common)

• gatewayUrl (default ws://127.0.0.1:18789)
• gatewayToken (if auth enabled)
• timeoutMs

• controlUrl (defaults from config)

​

Recommended agent flows

1. browser → status / start
2. snapshot (ai or aria)
3. act (click/type/press)
4. screenshot if you need visual confirmation

1. canvas → present
2. a2ui_push (optional)
3. snapshot

1. nodes → status
2. describe on the chosen node
3. notify / run / camera_snap / screen_record

​

Safety

• Avoid direct system.run; use nodes → run only with explicit user consent.
• Respect user consent for camera/screen capture.
• Use status/describe to ensure permissions before invoking media commands.

​

How tools are presented to the agent

1. System prompt text: a human-readable list + guidance.
2. Tool schema: the structured function definitions sent to the model API.