工具调用（Tools Invoke，HTTP）

OpenClaw 的网关暴露了一个简单的 HTTP 端点用于直接调用单个工具。它始终启用，但受网关认证和工具策略限制。

  • POST /tools/invoke
  • 与网关相同的端口（WS + HTTP 多路复用）：http://<gateway-host>:<port>/tools/invoke

默认最大负载大小为 2 MB。

认证

使用网关认证配置。发送 bearer 令牌：

  • Authorization: Bearer <token>

注意：

  • 当 gateway.auth.mode="token" 时，使用 gateway.auth.token（或 OPENCLAW_GATEWAY_TOKEN）。
  • 当 gateway.auth.mode="password" 时，使用 gateway.auth.password（或 OPENCLAW_GATEWAY_PASSWORD）。

请求体

{
  "tool": "sessions_list",
  "action": "json",
  "args": {},
  "sessionKey": "main",
  "dryRun": false
}

字段：

  • tool（字符串，必需）：要调用的工具名称。
  • action（字符串，可选）：如果工具 schema 支持 action 且 args 负载省略了它，则映射到 args。
  • args（对象，可选）：工具特定的参数。
  • sessionKey（字符串，可选）：目标会话键。如果省略或为 "main"，网关使用配置的主会话键（遵循 session.mainKey 和默认代理，或全局作用域中的 global）。
  • dryRun（布尔值，可选）：保留供将来使用；当前被忽略。

策略 + 路由行为

工具可用性通过网关代理使用的相同策略链过滤：

  • tools.profile / tools.byProvider.profile
  • tools.allow / tools.byProvider.allow
  • agents.<id>.tools.allow / agents.<id>.tools.byProvider.allow
  • 组策略（如果会话键映射到组或频道）
  • 子代理策略（当使用子代理会话键调用时）

如果策略不允许工具，端点返回 404。

为了帮助组策略解析上下文，你可以选择性地设置：

  • x-openclaw-message-channel: <channel>（例如：slack、telegram）
  • x-openclaw-account-id: <accountId>（当存在多个帐户时）

响应

  • 200 → { ok: true, result }
  • 400 → { ok: false, error: { type, message } }（无效请求或工具错误）
  • 401 → 未授权
  • 404 → 工具不可用（未找到或未在允许列表中）
  • 405 → 方法不允许

示例

curl -sS http://127.0.0.1:18789/tools/invoke \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "tool": "sessions_list",
    "action": "json",
    "args": {}
  }'
← 返回文档首页