mcpField
O
openclaw-relay

openclaw-relay

github.com/steipeteAgent workflows7.4k116 installsUpdated 1w ago
Repository

About openclaw-relay

OpenClaw Relay is a command-line skill for relaying messages and tasks to OpenClaw agent sessions over local or SSH transports. It supports target resolution, private asks, direct or session-mediated posts, and queued asynchronous work.

Key features

  1. 01Relay over local or SSH transport
  2. 02Resolve target aliases
  3. 03Ask, send, or publish messages
  4. 04Queue and poll asynchronous work
  5. 05Check relay health and status

Use cases

  1. 01Send a private question to an agent session
  2. 02Post a message to a resolved channel target
  3. 03Queue work on a remote OpenClaw session

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/steipete/agent-scripts --skill openclaw-relay

After installing, type/openclaw-relayin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
config/
session_aliases.json
scripts/
openclaw_relay.py
test_doctor_token.py

Details

From the project README

OpenClaw Relay

Use this when the job is:

  • "talk to Molty"
  • "relay this into an OpenClaw channel session"
  • "use acpx"
  • "send this through the gateway via acp"
  • "work through a remote OpenClaw bridge over SSH"

Not for team.openclaw.ai: starting or inspecting Roboclaw sessions on the Team server is $team-handoff from openclaw/agent-skills (one Gateway request as Peter through Cloudflare Access; operator values live in ~/.config/openclaw/team-handoff.env).

One skill. Two transports:

  1. local
  2. ssh

Default to local for direct telephone-game work from the current OpenClaw checkout. Use ssh when the target agent/session lives on another machine.

For Peter's setup, Molty normally lives on the Mac Studio gateway, reached as [email protected]; avoid the mac-studio SSH alias for one-shot relay work because that alias auto-attaches tmux.

Script path: scripts/openclaw_relay.py

Target aliases file: config/session_aliases.json

Mode Selection

Choose local when:

  • the user explicitly says acpx
  • the target session is on the current machine
  • the goal is quick relay or private ask

Choose ssh when:

  • the target agent/session lives on another host
  • you want a persistent bridge session
  • you need async queue/wait/show flows on a remote machine

Defaults

The script avoids baked-in personal paths. Override with env or flags when needed.

  • transport: local
  • local repo cwd: current working directory
  • local acpx repo: <cwd>/extensions/acpx
  • ssh host: [email protected]
  • remote repo cwd: <remote-home>/clawdbot
  • remote acpx repo: <remote-home>/Projects/oss/acpx
  • gateway token file: <home>/.openclaw/gateway.token
  • control session name: codex-bridge
  • target aliases file: config/session_aliases.json

Useful env vars:

  • OPENCLAW_RELAY_TRANSPORT
  • OPENCLAW_RELAY_HOST
  • OPENCLAW_RELAY_CWD
  • OPENCLAW_RELAY_ACPX_REPO
  • OPENCLAW_RELAY_GATEWAY_URL
  • OPENCLAW_RELAY_GATEWAY_TOKEN_FILE
  • OPENCLAW_RELAY_SESSION
  • OPENCLAW_RELAY_TARGETS_FILE

Quick Start

Health check:

python3 scripts/openclaw_relay.py doctor

List known target aliases:

python3 scripts/openclaw_relay.py targets

Resolve a target alias:

python3 scripts/openclaw_relay.py resolve --target maintainers

Ask a target session a question privately:

python3 scripts/openclaw_relay.py ask \
  --target maintainers \
  --message "Summarize the current vibe in this channel."

Force-send text to the resolved target:

python3 scripts/openclaw_relay.py force-send \
  --target maintainers \
  --text "Deploy is done."

For multiline posts, use --text-file <path> or --text-file - instead of shell-quoting the message.

Force-send media when the user explicitly wants a channel post:

python3 scripts/openclaw_relay.py force-send \
  --transport ssh \
  --host [email protected] \
  --target maintainers \
  --text "Demo video." \
  --media /tmp/demo.mp4

Use the persistent control session:

python3 scripts/openclaw_relay.py ensure
python3 scripts/openclaw_relay.py send --message "Reply with exactly OK."
python3 scripts/openclaw_relay.py show

Remote host example:

python3 scripts/openclaw_relay.py doctor --transport ssh --host [email protected]
python3 scripts/openclaw_relay.py send \
  --transport ssh \
  --host [email protected] \
  --message "Reply with exactly OK."

Async Workflow

Queue work and poll the same control session:

python3 scripts/openclaw_relay.py start --message "Work on X and reply when done."
python3 scripts/openclaw_relay.py wait --after-seq <last-seq>
python3 scripts/openclaw_relay.py show

Target Aliases

config/session_aliases.json ships with placeholders. Replace them with real values for your setup.

Example shape:

{
  "main": "agent:<agentId>:main",
  "maintainers": "agent:<agentId>:discord:channel:<channelId>"
}

Session Rules

Use these rules when choosing a command:

  • Want a private reply from a specific session: ask
  • Want the target session to decide whether to post: publish
  • Want a guaranteed direct post: force-send
  • Want blocking continuity with the control brain: send
  • Want fire-and-forget async: start, then wait and show
  • Want to stop queued work: cancel

Failure Handling

If relay work fails:

  1. Run doctor.
  2. Run status.
  3. Run show.
  4. If the control session is wedged, run cancel, then ensure, then retry.

If route discovery is uncertain:

  1. Resolve the target first.
  2. Prefer alias or exact session key.
  3. Use a tiny probe ask before sending the real payload.

Output Relay

Return the actual assistant text or delivery result, not shell noise.

For relay tasks, report:

  • transport used
  • target session key
  • whether the route probe/resolve succeeded
  • final posted or returned result

Comments

Markdown supported