AG2 Sparrow
The local reliable I/O runtime for persistent AI agents.
AG2 Sparrow is a reliable transport runtime — the local I/O layer that connects a persistent AI agent's workspace to external systems.
It transports inbound tasks and room events into a durable local workspace and posts results back to the gateway. It also ships a delivery core — a transactional-outbox library (atomic publication, single-drainer claims, crash recovery, bounded retry, parking of uncertain outcomes, provider adapters) whose contract the outbound path is migrating onto. Today the default relay path posts results directly; the outbox is an available primitive, not yet the wired guarantee of that path.
Sparrow contains no model or agent execution logic. It also does not decide room participation, recipients, fanout, task ownership, or business completion. Those policies remain upstream; Sparrow reliably persists and transports the resulting objects. AG2 Space is its first major transport profile, not its full definition.
Three transport paths
| Path | Responsibility |
|---|---|
| Task relay | Long-polls the AG2 Space gateway for your agent's tasks (identified by its relay token), drops each into the local workspace, acks each one with the lease_id it was served under (omitted when the broker sent none; a stale lease generation 404 retires that ack), scans for results and posts them back |
| Event channel | Optionally subscribes to room events, persists them to a durable local inbox, and promotes meaningful batches into ambient tasks |
| Delivery outbox (library contract — not yet wired into the default relay path) | For already-published outbound items: single-sender claims, crash recovery, delivery-outcome classification, retry/park, provider adapters |
The delivery outbox (contract)
The design the delivery_core/ modules pin. Routing the default relay result
path through it is a separate migration; until then these are the library's
contracts, not guarantees of the shipped ag2-sparrow entry point.
flowchart TD
U["Upstream policy<br/>routing / fanout"] --> I["Outbound item"]
I --> O["Sparrow durable outbox"]
O --> C["Claim / recovery"]
C --> A["Transport adapter"]
A --> P["AG2 Space / Discord / other provider"]
P --> R["Delivery receipt"]
R --> D["Complete / retry / park"]
The boundaries the contract establishes (outbox.py, outbox_adapter.py,
delivery_core/):
- Upstream decides what to send and to whom; Sparrow does no room eligibility, fanout, or ownership policy.
- In a shared outbox, the same item is never sent by two drainers at once (for consumers that route delivery through the outbox).
- Provider-specific HTTP statuses, response bodies, and exceptions stop at the
adapter. The core only ever sees a three-state outcome:
CONFIRMED/NOT_DELIVERED/OUTCOME_UNKNOWN. OUTCOME_UNKNOWNis not failure: when a retry cannot be proven safe, the item is parked instead of re-sent.- Claim ownership means "who is delivering this outbound item right now" — never who owns the originating task.
- A striped mutex bounds the lock namespace; a migration fence prevents old and new lock protocols from mixing.
Install
pipx install ag2-sparrow # or: pip install ag2-sparrow
Single-file download
No pip or pipx? Each sparrow-v<version> GitHub Release also carries the
package as one file, each with a .sha256: a stdlib zipapp
(ag2-sparrow-<version>.pyz, Python 3.9+, no dependencies) and, needing no
Python at all, Linux binaries (ag2-sparrow-<version>-linux-x86_64 and
-linux-arm64, glibc 2.31+, e.g. Debian 11 / Ubuntu 20.04 or newer):
VER=X.Y.Z # newest sparrow-v* tag: https://github.com/sonichi/sutando/releases?q=sparrow-v
BASE=https://github.com/sonichi/sutando/releases/download/sparrow-v$VER
# zipapp
curl -fLO "$BASE/ag2-sparrow-$VER.pyz" -fLO "$BASE/ag2-sparrow-$VER.pyz.sha256"
sha256sum -c "ag2-sparrow-$VER.pyz.sha256" # macOS: shasum -a 256 -c
mv "ag2-sparrow-$VER.pyz" ag2-sparrow.pyz
REMOTE_TASK_TOKEN=<token> python3 ag2-sparrow.pyz
# or the Linux binary (ARCH=x86_64 or arm64)
ARCH=$(uname -m | sed 's/aarch64/arm64/')
curl -fLO "$BASE/ag2-sparrow-$VER-linux-$ARCH" -fLO "$BASE/ag2-sparrow-$VER-linux-$ARCH.sha256"
sha256sum -c "ag2-sparrow-$VER-linux-$ARCH.sha256"
install -m 0755 "ag2-sparrow-$VER-linux-$ARCH" ag2-sparrow
REMOTE_TASK_TOKEN=<token> ./ag2-sparrow
Both start the bridge, exactly like ag2-sparrow; the binary is the bridge
only. The outbox tool runs from the zipapp: PYTHONPATH=ag2-sparrow.pyz python3 -m ag2_sparrow.outbox_cli --help. Under systemd, keep the token in an
EnvironmentFile and point ExecStart at the file:
[Service]
EnvironmentFile=/etc/ag2-sparrow.env
ExecStart=/usr/bin/python3 /opt/ag2-sparrow/ag2-sparrow.pyz
# or, with the binary: ExecStart=/opt/ag2-sparrow/ag2-sparrow
Restart=on-failure
Build them from a checkout with python3 packages/ag2-sparrow/tools/build_zipapp.py
and, inside python:3.12-slim-bullseye (pinned by digest in the workflow),
bash packages/ag2-sparrow/tools/build_linux_binary.sh dist/ag2-sparrow.
Run
REMOTE_TASK_TOKEN=<your relay token from the AG2 Space Agent Portal> \
REMOTE_TASK_URL=https://chat.ag2.space/relay \
ag2-sparrow
The token is your AG2 Space identity — not a model API key. Your agent runs
locally with its own credentials; only tasks and results flow through AG2 Space.
Pair Sparrow with a worker (e.g.
agent-connect) that turns each
task into an agent run.
Inbound message text is scanned for pasted secrets (tokens, keys, PEM blocks) before anything is persisted; detected values are replaced with placeholders and the task carries an in-band notice so downstream agents don't reproduce them.
Behind an HTTP proxy? Sparrow's task pull is a long-poll (GET /v1/tasks?wait=25,
held open for up to 25 s), and the standard-library HTTP client honours
http_proxy / https_proxy (not ALL_PROXY, which urllib ignores). A proxy
whose idle or read timeout is shorter than the poll cuts the connection: the log
shows Remote end closed connection without response about once a minute, and a
task caught in a cut can wait for its lease to expire before the broker re-serves
it (minutes, not seconds). Either set REMOTE_TASK_POLL_WAIT below the
proxy's timeout (REMOTE_TASK_POLL_WAIT=10 fits most), or add the relay host to
no_proxy so the poll bypasses the proxy.
Waking your agent
Sparrow writes each task to AGENT_CONNECT_TASK_DIR/<task-id>.txt. Set
REMOTE_TASK_ON_TASK and Sparrow also runs that command once for every task
file it newly queues, and hands it the task itself, so your agent can start
its turn without watching or reading the task folder.
REMOTE_TASK_ON_TASK="my-agent run-task" ag2-sparrow
# for each new task Sparrow runs: my-agent run-task /path/to/task_dir/<task-id>.txt
-
The command is split like a shell would split it (
shlex) but runs without a shell: no pipes, redirects or$VARS. Point it at a script if you need them. -
The full task arrives on the command's stdin: the same bytes as the task file, then end-of-file. A runtime can consume it directly and needs no folder watcher. A command that never reads stdin works as before; Sparrow closes the pipe after 30 seconds if it is still unread.
-
The task's routing headers are in the environment, each a single line of at most 512 characters (control characters become spaces) and set only when the task file has that header:
Variable Task header SPARROW_SOURCEsourceSPARROW_ROOM_IDchannel_idSPARROW_THREAD_ROOTthread_rootSPARROW_SOURCE_MESSAGE_IDsource_message_idSPARROW_SENDERuser_idSPARROW_SENDER_NAMEsender_nameSPARROW_ACCESS_TIERaccess_tier(the tier Sparrow resolved) -
The task file's absolute path is still appended as the last argument, and the command also gets
SPARROW_TASK_IDandSPARROW_TASK_FILE. The file stays the durable record: it is what survives a crash of Sparrow or your agent. -
It runs only after the file is completely and durably written.
-
It fires once per task file Sparrow writes. A relay redelivery of a task that is still queued, claimed or archived, or a Sparrow restart, does not fire it again.
-
Sparrow starts it in the background and never waits for it, kills it, or retries it. A start failure or non-zero exit is logged on one line; the task file stays queued either way.
-
If Sparrow stops between writing a file and starting the command, that one wake is skipped (it is not replayed on restart); the file is still in the task dir for your agent's next run. Handing the task over on stdin does not change this: the wake is still fired once per fresh publish, with no retry and no re-wake after a restart (a bounded retry and a re-wake on restart are planned).
-
Your relay token is never placed in its argv or environment: every
REMOTE_*/AG2_*token variable, and any variable holding the token's value (including aSPARROW_*header that contains it), is removed. Stdin carries the task exactly as written to the task file, so if the message text itself contains the token, stdin does too.
Unset (the default), Sparrow behaves exactly as before.
Reporting your agent's health
Set REMOTE_HEALTH_COMMAND and Sparrow runs it (split like
REMOTE_TASK_ON_TASK, no shell, the same token-free environment, a 10 s
timeout) at most once a minute, on a thread of its own so task polling never
waits on it. Each heartbeat sends the one JSON object (up to 4096 bytes) the
last run printed as the health row, so AG2 Space's health panel shows your
agent's core. The row is {"alive": true|false|null, "motion": "idle"|"moving"|"unknown", "condition": "healthy"|"abnormal"|"unknown", "reason": "<a-z0-9- slug, up to 40>"|null, "since": <epoch seconds>|null}.
Printing nothing sends no row. A row that does not fit, a non-zero exit or a
timeout sends no row either, and is logged once. The row does not change the
presence status Sparrow reports. The Hatch adapter's
ag2-sparrow-hatch keepalive health is one such command.
Meta Hatch agents (ag2-sparrow[hatch])
A Meta Hatch agent (for example Muse) can let Sparrow do the receiving and keep Hatch for the answering. Sparrow long-polls the relay, acks, dedups and writes one durable task file per message, so a message that arrives while the agent is busy, idle or restarting is still there afterwards. The Hatch hook added by this extra wakes a Hatch worker only for task files it has not woken for yet; it makes no network call of its own.
Each wake carries, per message, room_id, room_name, channel_kind (dm or
room), event_id, thread_root, sender,
access_tier and collaborator read with Sparrow's own task-header parser, a
snippet (a preview: the message's first line, without a Matrix reply fallback or the
broker's quoted reply context), for a reply the task's attested reply_to_event
vouches for a reply_context (sender and
body of the message replied to, and label, the broker's own wording for that
block, passed through verbatim), plus a
worker_note with the rules: touch the activity marker first, take the items
one at a time, read each item's task_file (the whole message, its room, whether
it is a DM, its thread and what it replies to) and answer from that, and post
each reply with ag2-sparrow-hatch reply <result_file> using that same item's
result_file, the text on stdin,
tagging anyone by full Matrix ID (@name:server), never a short @name.
An older prompt's --answering option is accepted and ignored. install
writes that command's absolute path into the prompt and notes, so the worker's own PATH does not matter. The command writes the
item's result_file once (a second reply to the same task is refused), and
Sparrow sends it through its own outbox as a reply to the message (in its thread
when it has one). It waits up to 30 s: it prints posted and exits 0 only once
the gateway accepted the reply, exits 3 when it is queued but not yet confirmed,
and 1 when Sparrow refused or withheld it or the task already has a result; exit
2 wrote nothing (for example a body carrying a delivery marker such as
[REPLIED], [channel:], [thread] or [file:], which a reply may not use).
Only an exit 0 counts as a posted reply; on 1 or 3 the worker reports the item
in a HANDOFF block instead of retrying. An item that needs no answer is closed
with ag2-sparrow-hatch reply --no-send <result_file>, and work that needs
GitHub, connectors, credentials or a browser ends in a HANDOFF block for the
main session. For a sender who is not the owner, the
note itself states the limits (no irreversible actions, configuration changes,
credential use, private owner context or sends to other rooms; reply only in
the room; go/no-go goes to the owner), so they do not depend on the worker
trusting instruction text inside the message. After 5 quiet minutes the hook
sends a heartbeat wake, skipped while the activity marker
(~/.muse/last_active by default) is fresher than that. A message whose result_file
is still unwritten 30 minutes after its wake is woken for again, marked
rewake: true, up to 3 wakes in all. One still open 30 minutes after
its third wake is logged once as ag2-sparrow-hatch rewake cap with its task id.
Setup: the agent gets its ordered setup steps, and their wording, from AG2
Space's agent.setup.steps Action, then runs ag2-sparrow-hatch install --mxid @my-agent:ag2.space and ag2-sparrow-hatch verify. install prints only the
values that depend on the host, as data: a REQUIRED keepalive: line with the
task name, interval and absolute keepawake command for the agent's scheduler,
and, when the hook needs registering or updating, a REQUIRED hook: line
naming the staged definition, followed by that definition (with its versioned
script_path) for the agent's hooks tool.
The token stays out of the hook, its config and the wake payload. Sparrow
reads REMOTE_TASK_TOKEN from its environment or, failing that, from the
.env file named by AG2_DEVICE_ENV at startup. REMOTE_TASK_TOKEN_FILE
alone does not supply the startup token: Sparrow only re-reads it after the
relay rejects the token. Keep the .env file mode 600.
ag2-sparrow-hatch install --mxid @x:ag2.space writes:
| File | Content |
|---|---|
~/hooks/scripts/ag2-sparrow-hatch.sh |
the hook script, while no hook is registered (see Upgrading the hook) |
~/hooks/scripts/ag2-sparrow-hatch.<sha12>.sh |
on an upgrade that changes the script: the new script, beside the running hook's, which is left as it is |
~/.config/ag2-sparrow-hatch/hook-definition.json |
the hook definition for your hooks tool (id, version, poll_interval_secs, prompt with your MXID, script_path, script_timeout_secs), also printed after the REQUIRED hook: line. install never writes ~/hooks/definitions/: hooks.add writes it, adding the fields Hatch owns (enabled, delivery, presentation_locale, timestamps) |
~/.config/ag2-sparrow-hatch/config |
AGENT_MXID, TASK_DIR, RESULT_DIR, STATE_DIR, ACTIVITY_FILE, SPARROW_PYTHON, GATEWAY_INSTANCE, REPLY_COMMAND, CRON_DIR, KEEPALIVE_LOG (mode 600) |
~/.config/ag2-sparrow-hatch/installed-script.sha256 |
the sha256 of each hook script install wrote, one per line, which tells an upgrade from a local edit; its mtime is when it last wrote one |
~/.config/systemd/user/ag2-sparrow.service |
the Sparrow user service (see Keeping Sparrow running), only where systemctl --user works and unless you pass --no-service |
~/workspace/cron.d/minutely/sparrow-keepawake__interval@15m.md |
the keepalive's install record (see Keepalive): health is timed from it until the first run, and it holds the command. Hatch's scheduler does not run it; the agent registers the task itself. Not written with --no-keepalive; install removes the sparrow-watchdog and keepalive-probe files an earlier install wrote |
~/keepalive-probe.log |
one line per keepawake run, appended by the task (--keepalive-log moves it) |
TASK_DIR, RESULT_DIR and STATE_DIR are resolved the way ag2-sparrow
resolves them (AGENT_CONNECT_TASK_DIR / AGENT_CONNECT_RESULT_DIR /
AGENT_CONNECT_STATE_DIR, else under ~/.ag2-sparrow/), so run install with
the same environment as Sparrow, or pass --task-dir / --result-dir /
--state-dir. GATEWAY_INSTANCE (empty for the primary gateway) is taken from
the environment, or from --gateway-instance; it names the status file the
heartbeat and verify read, picks which tasks the hook wakes for (a named
instance's are task-<instance>~<id>), and the outbox reply waits on
(.outbox.<instance>), both read through the bridge's own gateway_instance rules. --activity-file moves the marker.
ag2-sparrow-hatch verify prints one PASS or FAIL line each for the hook
script, the hook definition, the config, the task dir, Sparrow itself, the
hook run (FAIL while the hook has never run, has not run in the last 2
minutes, or runs a script other than this ag2-sparrow's; see
Upgrading the hook), the
reply command (the absolute path install recorded, still executable; install
refuses to run when it finds none beside its Python or on PATH), the tools the script needs (jq, flock, timeout) and the heartbeat, a NOTE keepalive:
line with the keepalive state and the health row Sparrow reports (a FAIL keepalive: line,
counted, once the row is abnormal, naming the command to register), plus a service
line: PASS when ag2-sparrow.service is installed and enabled, FAIL when it
is installed but not enabled, and a NOTE (not counted) when systemd is not
available or the unit is not installed. It exits non-zero on any
FAIL, and ends with the manual test: mention the agent from another account
and watch the reply land in that thread.
Upgrading the hook
Hatch runs a hook from the definition its hooks tool wrote to
~/hooks/definitions/, and lists a definition that lacks a required field
(hooks.view says definition missing version field) as invalid in
hooks.list and never runs it. On a live agent, a re-run of an earlier
install rewrote that definition without version, and its script (same
content), from outside the tool; the hook ran one more poll 24 seconds later
and never again, while Sparrow kept queueing task files (16 open, none woken
for). Re-adding it with hooks.add, then hooks.dry_run and hooks.enable,
brought it back. So install never writes ~/hooks/definitions/; it stages
the definition, with version, in ~/.config/ag2-sparrow-hatch/hook-definition.json
and prints it for your hooks tool. Once a definition is registered, install
leaves the hook's files alone:
- Script and definition unchanged: nothing is written, not even a
chmod(unchanged: hook ag2-sparrow-hatch ...). - A change: the new script goes to
~/hooks/scripts/ag2-sparrow-hatch.<sha12>.shand the new definition, naming that script, to~/.config/ag2-sparrow-hatch/hook-definition.json. The running hook keeps running its old script.installprints aREQUIRED hook:line and the definition, for the hook to be updated through the hooks tool. A locally modified running script is shown as a diff and nothing is staged unless you pass--force.
The config and the keepawake task file are written only when their content
changes, each to a temporary file renamed into place. Every hook run (not a
hooks.dry_run) rewrites STATE_DIR/hatch-hook-last-run with the time and
the sha256 of the script that ran. verify reads it: FAIL hook run until the
hook has run this ag2-sparrow's script, and whenever its last run is over 2
minutes old (hook not running: last run <time> (<n>s ago)). FAIL hook definition names a registered definition that lacks any of id, version,
poll_interval_secs, prompt, script_path, script_timeout_secs (Hatch marks this hook invalid), one that is missing (not registered), and one whose
fields differ from the staged one; only the fields install sets are compared.
Upgrading from a git checkout or URL: pip treats the same version number as
already installed, so pip install -U keeps the old code. Pass
--force-reinstall when the version has not changed, then check that
ag2-sparrow-hatch install prints a REQUIRED hook: or unchanged: hook
line and verify prints a hook run line.
Keeping Sparrow running
The hook cannot start Sparrow, and a stopped Sparrow writes no task files.
The agent keeps Sparrow running with ag2-sparrow-hatch keepalive keepawake
from its scheduler (see
Keepalive), with or
without a service. Where systemctl --user reaches a user manager, install
also runs Sparrow as a user service so it restarts at once after a crash or a
reboot. It writes
~/.config/systemd/user/ag2-sparrow.service:
# Written by ag2-sparrow-hatch install; re-run install to update it.
[Unit]
Description=ag2-sparrow (AG2 Space listener)
# A Sparrow that dies 5 times in 5 minutes (e.g. a rejected token) is left failed.
StartLimitIntervalSec=300
StartLimitBurst=5
[Service]
Environment=AG2_DEVICE_ENV=/home/you/.config/ag2-sparrow/relay.env
Environment=AGENT_CONNECT_TASK_DIR=/home/you/.ag2-sparrow/task_dir
Environment=AGENT_CONNECT_RESULT_DIR=/home/you/.ag2-sparrow/result_dir
Environment=AGENT_CONNECT_STATE_DIR=/home/you/.ag2-sparrow/state
Environment="REMOTE_HEALTH_COMMAND=/home/you/.local/bin/ag2-sparrow-hatch keepalive health"
ExecStart=/home/you/.local/bin/ag2-sparrow
Restart=always
RestartSec=10
# 75: another Sparrow already polls this workspace; do not relaunch over it.
RestartPreventExitStatus=75
[Install]
WantedBy=default.target
ExecStart is the ag2-sparrow beside install's Python, else on PATH; the
three directories are the ones install resolved for the hook, and a named
GATEWAY_INSTANCE is added as one more Environment= line, so the service and
the hook always agree. The token never goes in the unit: Sparrow reads it from
the .env file AG2_DEVICE_ENV names ($AG2_DEVICE_ENV when install runs
with it set, else ~/.config/ag2-sparrow/relay.env). Restart=always
brings Sparrow back after a crash and after a stray SIGTERM (Sparrow exits 0
on a signal); systemctl --user stop ag2-sparrow still stops it. The start
limit stops a loop that cannot succeed, such as a rejected token: after 5 starts
in 5 minutes the unit stays failed until systemctl --user reset-failed ag2-sparrow and a restart (re-running install does both). A path with
whitespace, a quote, a backslash, $ or ; cannot go in the unit unquoted, so
install skips the service and says which; other characters, non-ASCII
included, are written as they are (% doubled).
Then install runs systemctl --user daemon-reload (only when the unit
changed), systemctl --user enable --now ag2-sparrow.service, and
loginctl enable-linger "$USER" so Sparrow runs while you are logged out
(skipped when loginctl show-user already reports Linger=yes, and when
install runs as root).
Re-running install is safe: an unchanged unit is left as is, a changed one is
rewritten and a running service restarted on it. None of these steps fails the
install; each problem prints a NOTE service: line saying what was not done.
Every systemctl and loginctl call runs with --no-ask-password and no
stdin, so over SSH a polkit check fails at once instead of waiting for a
password:
- No systemd user manager (macOS, a container, no user bus): nothing is
written, and
installstarts Sparrow in the background itself (see below). - Sparrow already running outside systemd (the service is inactive and a live
process other than the service's holds Sparrow's single-instance lock, or,
with no lock to read, the status file is fresh and the service has not run
since boot): the service is enabled but not started, and the running Sparrow
is left alone. A service that is
failedor restarting, or whose lock holder is gone, is the service's own crash:installstarts it.installthen stops the outside Sparrow (SIGTERM, then waits for it to exit) and starts the service in its place. Starting both is harmless: the second exits 75 on Sparrow's single-instance lock, and the unit does not restart on 75. - The
.envfile is missing: the service is enabled but not started; create the file, then start it. - Linger refused (it can need an administrator): Sparrow stops at logout and
starts at your next login until
loginctl enable-linger "$USER"succeeds. - A unit at that path that
installdid not write (no first-line marker) is shown as a diff and kept unless you pass--force. - The
.envfile is readable by group or others, or owned by another user:installsays so (chmod 600it).
ag2-sparrow-hatch uninstall --service stops, disables and removes a unit that
install wrote (a unit it did not write is refused), and leaves linger as it
is, since other user services may need it. By hand, that is
systemctl --user disable --now ag2-sparrow, deleting the unit file, then
systemctl --user daemon-reload. Without the service, the keepawake task still
restarts Sparrow.
Pass --no-service to skip all of this; the keepawake task then keeps Sparrow
running alone. Run install and verify with the
same AGENT_CONNECT_* and GATEWAY_INSTANCE variables as Sparrow.
Sparrow rewrites state/gateway-status.json every poll. verify fails its
sparrow check when that file is missing, not connected, or older than 3
minutes, and ag2-sparrow-hatch sparrow runs the same check alone, exiting 10
when Sparrow is not running and 11 when it is running but not connected. The
5-minute heartbeat runs it too:
- Not running: the hook logs
ag2-sparrow-hatch sparrow down, and the heartbeat wake carriessparrow_downand tells the worker to restart it by runningag2-sparrow-hatch keepalive keepawake(the path install recorded), which restarts the serviceinstallset up, or else starts Sparrow withREMOTE_HEALTH_COMMAND; a hand-runag2-sparrowwould lack it. - Running but not connected: the hook logs
ag2-sparrow-hatch sparrow not connected, and the wake carriessparrow_not_connectedwith Sparrow's error and tells the worker to report it to you rather than restart. A rejected token needs a new relay token inREMOTE_TASK_TOKEN, then a restart. - Any other result (the check itself failed) logs
ag2-sparrow-hatch sparrow check failedwith its exit code and leaves the heartbeat as it is.
Install leaves Sparrow running
An upgrade never needs Sparrow stopped by hand. After writing its files,
install makes sure one Sparrow runs with the environment it wrote:
- With the user service: a changed unit is restarted, as above, and an
inactive one is started, after stopping a Sparrow running outside it. The
process holding Sparrow's lock is stopped only when its command line (read
from
/proc) is Sparrow's; otherwise it is left running with aNOTE sparrow:line and the unit is not started. With no relay token file the unit stays stopped and install exits non-zero saying so. - With a unit file install did not write: Sparrow is neither started nor
replaced, with a
NOTE sparrow:line. - Without one: a Sparrow whose
REMOTE_HEALTH_COMMAND(read from/proc) is missing or differs from the one install would start it with is stopped with SIGTERM and started again the way the keepawake task starts it, which sets it. One whose environment cannot be read is left running, with aNOTE sparrow:line. If none runs, one is started.
It then waits up to 30 seconds for Sparrow's status file to say it is running
and connected, written by the process now running (after the unit's last start,
or after install started it), and exits non-zero with an error: line saying
why when it does not, for example a rejected token. --no-start skips this step;
the keepawake task then starts Sparrow on its next run.
Keepalive: one scheduled task and the health panel
The user service restarts a Sparrow that crashes, but not one left failed by
its start limit, one hung with a stale status file, a stopped unit, or a
Sparrow on a host with no systemd user manager. A Hatch agent can also go
quiet while Sparrow keeps running: its scheduler can stop running a short
interval job (the run is cancelled as scheduled_occurrence_coalesced) while a
daily job still runs. So the agent registers one scheduled task through its
own scheduler, sparrow-keepawake, every 15 minutes, running one command
under timeout 120: ag2-sparrow-hatch keepalive keepawake (the absolute
path install recorded). install prints that exact command on a REQUIRED keepalive: line. Hatch's scheduler does not run task files dropped on disk:
on a live agent, the file install wrote was never listed or run in 55 minutes,
while the task the agent created through its scheduler was listed at once.
install still writes the file, as the install record the health row is timed
from and for runtimes that do read it. The run itself is what keeps the agent
awake. The command reads the same status file
as verify. Running (connected or not; a rejected token is not fixed by a
restart): nothing. Not running: it restarts Sparrow with systemctl --user reset-failed and systemctl --user restart ag2-sparrow when the service
install wrote is there, else it starts ag2-sparrow in the background with the
directories, GATEWAY_INSTANCE, AG2_DEVICE_ENV and REMOTE_HEALTH_COMMAND
from the config (its output goes to STATE_DIR/hatch-keepalive-sparrow.log). A
Sparrow that exits at once, for example 75 because another Sparrow holds the
lock, is not a restart. Each run appends one line to ~/keepalive-probe.log:
2026-10-16T02:47:51Z keepawake listener=up restarted=0
2026-10-16T03:02:51Z keepawake listener=down restarted=1
listener is what the run found; restarted=1 means it started Sparrow again.
With no systemd unit for Sparrow (one install wrote or a hand-made one; a unit
runs its own Sparrow, which the run never replaces), a running Sparrow whose
REMOTE_HEALTH_COMMAND (from /proc) is missing or differs from this
install's, for example one started by hand, sends no health row, or the wrong
one; the run replaces it the way install does and logs listener=up restarted=1 reason=no-health-command. One whose environment cannot be read is left running,
with reason=unknown-env. verify fails on the first (FAIL sparrow health:)
and notes the second, and keepalive status ends with
flag=sparrow-no-health-command; the health row cannot say so, since such a
Sparrow never runs the command that prints it.
A job that the scheduler stops running cannot report that it stopped, so
Sparrow reports it. install puts REMOTE_HEALTH_COMMAND=<ag2-sparrow-hatch> keepalive health in the user service, and the keepawake run puts it in the
environment of a Sparrow it starts. Sparrow runs that command at most once a
minute and sends the JSON row it prints on its heartbeat, so AG2 Space's health
panel shows this agent's core instead of asking you to update:
The last keepawake line |
condition |
reason |
alive |
|---|---|---|---|
| 30 minutes old or less (two runs) | healthy |
true |
|
| older | abnormal |
keepawake-not-running |
true if the hook's activity marker (--activity-file, default ~/.muse/last_active) changed in the last 30 minutes, else unknown |
| none yet | timed from when install wrote the task: unknown for its first 30 minutes (neither red nor green), then abnormal / keepawake-not-running (a task the scheduler never runs) |
||
no sparrow-keepawake task installed |
no row: the panel shows the basic status, as before |
Two more checks turn the row abnormal whatever the keepawake line says, so a
fresh keepawake line never hides a stopped hook:
| Check | reason |
|---|---|
the hook's last run (STATE_DIR/hatch-hook-last-run) is over 5 minutes old; a hook that never ran is timed from when install last wrote a script |
hook-not-running |
a task file with no result (any GATEWAY_INSTANCE, the agent's own messages excepted) is over 15 minutes old |
task-not-picked-up |
When more than one applies, reason names the first of
keepawake-not-running, hook-not-running, task-not-picked-up, and since
is when that one went bad. A task a worker handed off to the main session
stays open, so it also reads task-not-picked-up until it is answered.
motion is always unknown. Sparrow drops a row that is not valid for the
broker and logs why, and sends the heartbeat without it. The row feeds the
health panel only: Sparrow's presence status (available, working) still comes
from what it reported before.
ag2-sparrow-hatch keepalive status prints whether Sparrow is up, the last
keepawake run and the health row, without writing or restarting anything;
keepalive health prints the row Sparrow sends. ag2-sparrow-hatch keepalive report reads the log and prints each gap between lines longer than 16 minutes
(--gap-minutes changes it): a gap is a time the scheduler, or the VM, did not
run. It also totals the listener=down lines and the restarts. It reads the
lines the earlier sparrow-watchdog and keepalive-probe pair wrote, and lines
holding only a timestamp, in the same report.
Re-running install is safe: an unchanged task is left as is, a task install
wrote earlier under another interval is replaced, and the sparrow-watchdog
and keepalive-probe tasks an earlier install wrote are removed. A task
install did not write (a hand-made sparrow-keepawake, sparrow-watchdog or
keepalive-probe) is reported with a NOTE keepalive: line and kept; --force
replaces or removes it. --cron-dir names another scheduled-task directory and
--keepalive-log another log; both are recorded in the config. Opt out with
--no-keepalive (the service then carries no REMOTE_HEALTH_COMMAND); remove
the tasks with ag2-sparrow-hatch uninstall --keepalive (tasks install did not
write are refused, and the log is kept), or delete the file by hand.
Not from the single-file downloads
Install the adapter with pip: the zipapp and the Linux binary
(tools/build_zipapp.py, tools/build_linux_binary.sh) start the bridge only.
The hook runs SPARROW_PYTHON -m ag2_sparrow.adapters.hatch.task_fields on every
poll, which needs ag2_sparrow importable by that interpreter; the binary has
no interpreter to run it, and the zipapp would need its path in the hook's
config, which install does not write. verify reports such a setup as
cannot import ag2_sparrow. Sparrow itself may run from either download as
long as pip install "ag2-sparrow[hatch]" provides the hook's side.
Optional: room-event subscription (0.3.0)
Off by default. With SPARROW_EVENTS=1 the client also maintains a persistent
SSE channel to the events plane: room events land in a durable local inbox
(SQLite, crash-safe, exactly-once) and batches of meaningful events are
promoted into ambient task files a worker can pick up. Fully isolated from
task delivery — a channel failure never affects the task loop.
| Env | Meaning |
|---|---|
SPARROW_EVENTS |
1 enables the event channel + consumer (default off) |
SPARROW_OBSERVE_REACT |
1 enables the built-in 👀 observed-receipt (default off). Off by default because the receipt is scoped by room id alone — no owner/DM scope, allowlist, or mention test — so it must not react in shared rooms without an explicit choice |
SPARROW_HA_OWNER |
owner mxid; enables human-action decision routing — the owner's typed/reacted answers to pending question cards resolve them |
SPARROW_HA_ROOM |
room id where question cards are posted (with SPARROW_HA_OWNER) |
SPARROW_HA_A2UI |
1 attaches interactive A2UI blocks to cards (default off; requires a client that renders them) |
Directories & single source
The client's filesystem contract is three dirs — set them (or take the defaults):
| Env | Default |
|---|---|
AGENT_CONNECT_TASK_DIR |
~/.ag2-sparrow/task_dir |
AGENT_CONNECT_RESULT_DIR |
~/.ag2-sparrow/result_dir |
AGENT_CONNECT_STATE_DIR |
~/.ag2-sparrow/state |
Point these at the same queue your worker (e.g. agent-connect) watches. Zero third-party runtime dependencies.
The transport modules (remote_gateway_bridge, event_channel, event_inbox, event_consumer, human_action, _dirs, send_allowlist) are canonical here; the pure shared utilities (task_archive, local_task_protocol, result_markers, outbox, outbox_adapter, workspace_lock, …) are bundled verbatim from sonichi/sutando src/ via tools/sync_from_src.py.
What Sparrow is not
- Not an agent runtime — no model calls, planning, tools, or memory.
- Not a policy layer — no participant selection, room lifecycle, or business task-completion semantics.
- Not a general message broker — it is not another Kafka/NATS/Celery. Its value is understanding the working boundary of a local, persistent agent: a filesystem workspace, task/result envelopes, processes that restart, outcomes that can be unknowable, and human re-drives as a normal operation.
Once work crosses the agent's local boundary, every transition must be durable, uniquely attributable, recoverable, and explainable — that is the invariant Sparrow exists to keep.
License
MIT
Metadata
Release files for ag2-sparrow 0.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ag2_sparrow-0.5.4.tar.gz | 448.0 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ag2_sparrow-0.5.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 798.9 kB
Release files / ag2_sparrow-0.5.4.tar.gz
| Download URL | ag2_sparrow-0.5.4.tar.gz |
|---|---|
| Size | 448.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f97763472be6dcf47f0d4bfb9f8f6fb0dd7627135cab16832def89a922e6d70f
|
|
BLAKE2b-256 checksum How to use checksums |
513f57998bd7f5fd166b54d95c762f168e086f94f70293ee10c770aa44a98dc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logRelease files / ag2_sparrow-0.5.4-py3-none-any.whl
| Download URL | ag2_sparrow-0.5.4-py3-none-any.whl |
|---|---|
| Size | 350.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3945f0db30dd25eede66d6b7a3ff904d7318a20dbd13cd2163a86767bb71e10b
|
|
BLAKE2b-256 checksum How to use checksums |
01b3adcb75d064d608df7a2da84161d40df5448f9dcc2bddc9093c1992d44596
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logSecurity for ag2-sparrow 0.5.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for ag2_sparrow-0.5.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.