a498c268c5
New adapter type for invoking OpenClaw agents via the gateway protocol. Registers in server, CLI, and UI adapter registries. Adds onboarding wizard support with gateway URL field and e2e smoke test script. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
42 lines
1.9 KiB
TypeScript
42 lines
1.9 KiB
TypeScript
export const type = "openclaw_gateway";
|
|
export const label = "OpenClaw Gateway";
|
|
|
|
export const models: { id: string; label: string }[] = [];
|
|
|
|
export const agentConfigurationDoc = `# openclaw_gateway agent configuration
|
|
|
|
Adapter: openclaw_gateway
|
|
|
|
Use when:
|
|
- You want Paperclip to invoke OpenClaw over the Gateway WebSocket protocol.
|
|
- You want native gateway auth/connect semantics instead of HTTP /v1/responses or /hooks/*.
|
|
|
|
Don't use when:
|
|
- You only expose OpenClaw HTTP endpoints (use openclaw adapter with sse/webhook transport).
|
|
- Your deployment does not permit outbound WebSocket access from the Paperclip server.
|
|
|
|
Core fields:
|
|
- url (string, required): OpenClaw gateway WebSocket URL (ws:// or wss://)
|
|
- headers (object, optional): handshake headers; supports x-openclaw-token / x-openclaw-auth
|
|
- authToken (string, optional): shared gateway token override
|
|
- password (string, optional): gateway shared password, if configured
|
|
|
|
Gateway connect identity fields:
|
|
- clientId (string, optional): gateway client id (default gateway-client)
|
|
- clientMode (string, optional): gateway client mode (default backend)
|
|
- clientVersion (string, optional): client version string
|
|
- role (string, optional): gateway role (default operator)
|
|
- scopes (string[] | comma string, optional): gateway scopes (default ["operator.admin"])
|
|
- disableDeviceAuth (boolean, optional): disable signed device payload in connect params (default false)
|
|
|
|
Request behavior fields:
|
|
- payloadTemplate (object, optional): additional fields merged into gateway agent params
|
|
- timeoutSec (number, optional): adapter timeout in seconds (default 120)
|
|
- waitTimeoutMs (number, optional): agent.wait timeout override (default timeoutSec * 1000)
|
|
- paperclipApiUrl (string, optional): absolute Paperclip base URL advertised in wake text
|
|
|
|
Session routing fields:
|
|
- sessionKeyStrategy (string, optional): fixed (default), issue, or run
|
|
- sessionKey (string, optional): fixed session key when strategy=fixed (default paperclip)
|
|
`;
|