Lobster

Lobster 是一个工作流 shell,让 OpenClaw 能够将多步骤工具序列作为单个确定性操作运行,并带有明确的审批检查点。

核心亮点

你的助手可以构建管理自己的工具。你提出一个工作流需求,30 分钟后就有了一个 CLI 加上可以一次调用运行的管道。Lobster 就是缺失的那一块:确定性管道、明确的审批和可恢复的状态。

为什么需要它

现在,复杂的工作流需要很多来回的工具调用。每次调用都消耗 Token,而且 LLM 必须编排每一步。Lobster 把这种编排移到了一个类型化的 Runtime 中:

  • 一次调用代替多次:OpenClaw 运行一次 Lobster 工具调用,就能得到结构化的结果。
  • 内置审批机制:副作用(发送邮件、发布评论)会暂停工作流,直到明确批准。
  • 可恢复:暂停的工作流返回一个 Token;批准后可以恢复,无需重新运行所有步骤。

为什么用 DSL 而不是普通程序?

Lobster 故意设计得很小。目标不是”一门新语言”,而是一个可预测的、对 AI 友好的管道规范,内置一流的审批和恢复 Token。

  • 内置审批/恢复:普通程序可以提示人类,但它无法用持久 Token 暂停和恢复,除非你自己发明那个 Runtime。
  • 确定性 + 可审计性:管道是数据,所以很容易记录、对比、重放和审查。
  • 为 AI 约束的表面:微小的语法 + JSON 管道减少了”创造性”的代码路径,使验证变得现实。
  • 内置安全策略:超时、输出上限、Sandbox 检查和白名单由 Runtime 强制执行,而不是每个脚本。
  • 仍然可编程:每一步都可以调用任何 CLI 或脚本。如果你想用 JS/TS,可以从代码生成 .lobster 文件。

工作原理

OpenClaw 在 tool mode 中启动本地的 lobster CLI,并从 stdout 解析 JSON 信封。 如果管道暂停等待审批,工具会返回一个 resumeToken,这样你可以稍后继续。

模式:小型 CLI + JSON 管道 + 审批

构建输出 JSON 的小命令,然后将它们链接到单个 Lobster 调用中。(下面的示例命令名 — 换成你自己的。)

inbox list --json
inbox categorize --json
inbox apply --json
{
  "action": "run",
  "pipeline": "exec --json --shell 'inbox list --json' | exec --stdin json --shell 'inbox categorize --json' | exec --stdin json --shell 'inbox apply --json' | approve --preview-from-stdin --limit 5 --prompt 'Apply changes?'",
  "timeoutMs": 30000
}

如果管道请求审批,用 Token 恢复:

{
  "action": "resume",
  "token": "<resumeToken>",
  "approve": true
}

AI 触发工作流;Lobster 执行步骤。审批门让副作用保持明确和可审计。

示例:将输入项映射到工具调用:

gog.gmail.search --query 'newer_than:1d' \
  | openclaw.invoke --tool message --action send --each --item-key message --args-json '{"provider":"telegram","to":"..."}'

纯 JSON 的 LLM 步骤(llm-task)

对于需要 结构化 LLM 步骤 的工作流,启用可选的 llm-task Plugin 工具,并从 Lobster 调用它。这让工作流保持确定性,同时仍然允许你用模型进行分类/总结/起草。

启用工具:

{
  "plugins": {
    "entries": {
      "llm-task": { "enabled": true }
    }
  },
  "agents": {
    "list": [
      {
        "id": "main",
        "tools": { "allow": ["llm-task"] }
      }
    ]
  }
}

在管道中使用:

openclaw.invoke --tool llm-task --action json --args-json '{
  "prompt": "Given the input email, return intent and draft.",
  "input": { "subject": "Hello", "body": "Can you help?" },
  "schema": {
    "type": "object",
    "properties": {
      "intent": { "type": "string" },
      "draft": { "type": "string" }
    },
    "required": ["intent", "draft"],
    "additionalProperties": false
  }
}'

详情和配置选项请参阅 LLM Task

工作流文件(.lobster)

Lobster 可以运行带有 nameargsstepsenvconditionapproval 字段的 YAML/JSON 工作流文件。在 OpenClaw 工具调用中,将 pipeline 设置为文件路径。

name: inbox-triage
args:
  tag:
    default: "family"
steps:
  - id: collect
    command: inbox list --json
  - id: categorize
    command: inbox categorize --json
    stdin: $collect.stdout
  - id: approve
    command: inbox apply --approve
    stdin: $categorize.stdout
    approval: required
  - id: execute
    command: inbox apply --execute
    stdin: $categorize.stdout
    condition: $approve.approved

注意:

  • stdin: $step.stdoutstdin: $step.json 传递前一步的输出。
  • condition(或 when)可以根据 $step.approved 来控制步骤。

安装 Lobster

在运行 OpenClaw Gateway 的 同一主机 上安装 Lobster CLI(参见 Lobster 仓库),并确保 lobsterPATH 中。 如果你想使用自定义的二进制位置,在工具调用中传递 绝对路径 lobsterPath

启用工具

Lobster 是一个 可选的 Plugin 工具(默认不启用)。

推荐方式(增量式,安全):

{
  "tools": {
    "alsoAllow": ["lobster"]
  }
}

或者按 Agent 配置:

{
  "agents": {
    "list": [
      {
        "id": "main",
        "tools": {
          "alsoAllow": ["lobster"]
        }
      }
    ]
  }
}

避免使用 tools.allow: ["lobster"],除非你打算在限制性白名单模式下运行。

注意:白名单对可选 Plugin 是选择性加入的。如果你的白名单只列出 Plugin 工具(如 lobster),OpenClaw 会保持核心工具启用。要限制核心工具,也要在白名单中包含你想要的核心工具或组。

示例:邮件分类

没有 Lobster:

用户:"检查我的邮件并起草回复"
→ openclaw 调用 gmail.list
→ LLM 总结
→ 用户:"给 #2 和 #5 起草回复"
→ LLM 起草
→ 用户:"发送 #2"
→ openclaw 调用 gmail.send
(每天重复,不记得哪些已经分类过)

有了 Lobster:

{
  "action": "run",
  "pipeline": "email.triage --limit 20",
  "timeoutMs": 30000
}

返回 JSON 信封(截断):

{
  "ok": true,
  "status": "needs_approval",
  "output": [{ "summary": "5 need replies, 2 need action" }],
  "requiresApproval": {
    "type": "approval_request",
    "prompt": "Send 2 draft replies?",
    "items": [],
    "resumeToken": "..."
  }
}

用户批准 → 恢复:

{
  "action": "resume",
  "token": "<resumeToken>",
  "approve": true
}

一个工作流。确定性。安全。

工具参数

run

在 tool mode 中运行管道。

{
  "action": "run",
  "pipeline": "gog.gmail.search --query 'newer_than:1d' | email.triage",
  "cwd": "/path/to/workspace",
  "timeoutMs": 30000,
  "maxStdoutBytes": 512000
}

运行带参数的工作流文件:

{
  "action": "run",
  "pipeline": "/path/to/inbox-triage.lobster",
  "argsJson": "{\"tag\":\"family\"}"
}

resume

在审批后继续暂停的工作流。

{
  "action": "resume",
  "token": "<resumeToken>",
  "approve": true
}

可选输入

  • lobsterPath:Lobster 二进制文件的绝对路径(省略则使用 PATH)。
  • cwd:管道的工作目录(默认为当前进程工作目录)。
  • timeoutMs:如果超过此时长则终止子进程(默认:20000)。
  • maxStdoutBytes:如果 stdout 超过此大小则终止子进程(默认:512000)。
  • argsJson:传递给 lobster run --args-json 的 JSON 字符串(仅工作流文件)。

输出信封

Lobster 返回一个 JSON 信封,包含三种状态之一:

  • ok → 成功完成
  • needs_approval → 已暂停;需要 requiresApproval.resumeToken 来恢复
  • cancelled → 明确拒绝或取消

工具在 content(美化的 JSON)和 details(原始对象)中都会显示信封。

审批

如果存在 requiresApproval,检查提示并决定:

  • approve: true → 恢复并继续副作用
  • approve: false → 取消并完成工作流

使用 approve --preview-from-stdin --limit N 可以将 JSON 预览附加到审批请求,无需自定义 jq/heredoc 粘合。恢复 Token 现在很紧凑:Lobster 将工作流恢复状态存储在其状态目录下,并返回一个小的 Token 键。

OpenProse

OpenProse 与 Lobster 配合得很好:使用 /prose 来编排多 Agent 准备,然后运行 Lobster 管道进行确定性审批。如果 Prose 程序需要 Lobster,通过 tools.subagents.tools 为子 Agent 允许 lobster 工具。参见 OpenProse

安全性

  • 仅本地子进程 — Plugin 本身不进行网络调用。
  • 无密钥 — Lobster 不管理 OAuth;它调用管理 OAuth 的 OpenClaw 工具。
  • Sandbox 感知 — 当工具上下文处于沙箱时禁用。
  • 加固 — 如果指定了 lobsterPath 必须是绝对路径;强制执行超时和输出上限。

故障排除

  • lobster subprocess timed out → 增加 timeoutMs,或拆分长管道。
  • lobster output exceeded maxStdoutBytes → 提高 maxStdoutBytes 或减少输出大小。
  • lobster returned invalid JSON → 确保管道在 tool mode 中运行,并且只打印 JSON。
  • lobster failed (code …) → 在终端中运行相同的管道来检查 stderr。

了解更多

案例研究:社区工作流

一个公开示例:“第二大脑” CLI + Lobster 管道,管理三个 Markdown 库(个人、伴侣、共享)。CLI 输出 JSON 格式的统计、收件箱列表和过期扫描;Lobster 将这些命令链接成工作流,如 weekly-reviewinbox-triagememory-consolidationshared-task-sync,每个都带有审批门。AI 在可用时处理判断(分类),不可用时回退到确定性规则。