Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
152 lines
4.3 KiB
Markdown
152 lines
4.3 KiB
Markdown
---
|
|
summary: "Raft External Agent support through the Raft CLI wake bridge"
|
|
read_when:
|
|
- You want to connect OpenClaw to a Raft workspace
|
|
- You are configuring a Raft External Agent
|
|
- You are debugging Raft wake delivery
|
|
title: "Raft"
|
|
sidebarTitle: "Raft"
|
|
---
|
|
|
|
Raft connects an OpenClaw agent to a Raft External Agent through the local
|
|
Raft CLI. Raft sends authenticated wake hints to the Gateway; the agent then
|
|
uses the Raft CLI to check and send messages. Direct chat only (no groups).
|
|
|
|
## Install
|
|
|
|
Raft is an official external plugin. Install it on the Gateway host:
|
|
|
|
```bash
|
|
openclaw plugins install @openclaw/raft
|
|
openclaw gateway restart
|
|
```
|
|
|
|
Details: [Plugins](/tools/plugin)
|
|
|
|
## Prerequisites
|
|
|
|
- A Raft workspace with an External Agent.
|
|
- The Raft CLI installed on the same host as the OpenClaw Gateway, on the
|
|
service's `PATH`.
|
|
- A Raft CLI profile that is already signed in and associated with that
|
|
External Agent.
|
|
|
|
The plugin does not store Raft credentials; the Raft CLI keeps that
|
|
authentication in its own profile.
|
|
|
|
## Configure
|
|
|
|
Set the profile in config:
|
|
|
|
```json5
|
|
{
|
|
channels: {
|
|
raft: {
|
|
enabled: true,
|
|
profile: "openclaw",
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
For the default account, you can instead set `RAFT_PROFILE` in the Gateway
|
|
environment:
|
|
|
|
```bash
|
|
RAFT_PROFILE=openclaw
|
|
```
|
|
|
|
Use a named account when one Gateway connects to more than one Raft External Agent:
|
|
|
|
```json5
|
|
{
|
|
channels: {
|
|
raft: {
|
|
accounts: {
|
|
support: {
|
|
profile: "support-agent",
|
|
},
|
|
engineering: {
|
|
profile: "engineering-agent",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
Interactive setup records the same profile:
|
|
|
|
```bash
|
|
openclaw channels add --channel raft
|
|
```
|
|
|
|
## How it works
|
|
|
|
When the Gateway starts, the plugin:
|
|
|
|
1. Opens a loopback-only HTTP wake endpoint on an ephemeral port.
|
|
2. Starts `raft --profile <profile> agent bridge` with that endpoint and a
|
|
per-process token.
|
|
3. Accepts only authenticated, content-free wake hints with a replay identity
|
|
from the local bridge.
|
|
4. Requires one of `eventId`, `attemptId`, `messageId`, `delivery_id`,
|
|
`wake_id`, or `id` on every wake payload.
|
|
5. Deduplicates retried wake deliveries by bridge event id for 24 hours,
|
|
including across Gateway restarts.
|
|
6. Returns a stable runtime session for the current bridge and an empty
|
|
activity-drain batch for the Raft CLI protocol.
|
|
7. Starts one serialized OpenClaw agent turn per accepted wake.
|
|
|
|
The bridge owns Raft delivery retries and reconnects. The OpenClaw turn
|
|
receives only a wake notice, not a copied Raft message body. It uses the CLI
|
|
to read pending messages and to send its response:
|
|
|
|
```bash
|
|
raft --profile openclaw message check
|
|
raft --profile openclaw message send
|
|
```
|
|
|
|
<Note>
|
|
Raft is not a push-message transport. OpenClaw does not automatically send the model's final text back through the bridge, so the agent must use the Raft CLI after processing a wake.
|
|
</Note>
|
|
|
|
## Verify
|
|
|
|
Check that OpenClaw can find the CLI and has a configured profile:
|
|
|
|
```bash
|
|
openclaw channels status --probe
|
|
openclaw plugins inspect raft --runtime --json
|
|
```
|
|
|
|
Then send a message to the Raft External Agent. The Gateway log should show
|
|
the Raft bridge starting, followed by an inbound wake. The agent should use
|
|
the configured Raft profile to check its pending messages.
|
|
|
|
## Troubleshooting
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Raft CLI is missing">
|
|
Install the Raft CLI on the Gateway host and make `raft` available on the
|
|
service's `PATH`. Verify it with `raft --help`, then restart the Gateway.
|
|
</Accordion>
|
|
<Accordion title="The bridge exits immediately">
|
|
Verify the configured profile is signed in and belongs to the intended
|
|
Raft External Agent. Run `raft --profile <profile> agent bridge` directly
|
|
to see the CLI diagnostic.
|
|
</Accordion>
|
|
<Accordion title="A wake arrives but no Raft response is sent">
|
|
This is expected when the agent does not invoke the Raft CLI. The wake
|
|
bridge does not carry message bodies or automatic final replies. Check the
|
|
agent's tool policy and ensure it can run `raft --profile <profile>
|
|
message check` and `message send`.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## References
|
|
|
|
- [Raft](https://raft.build/)
|
|
- [Raft documentation](https://docs.raft.build/welcome/)
|
|
- [Hermes Raft integration](https://hermes-agent.nousresearch.com/docs/user-guide/messaging/raft)
|