Files
codex/codex-rs/ext/agent-message-board/README.md
T
jif 97239fd052 Add explicit local board connections with fixed runtime access (#53400)
## Why

Local message boards were scoped to an agent tree. Independently created Codex runtimes need a way to share a board while receiving different access permissions.

## What changed

- Add `LocalBoard` and `LocalBoardConnection` so hosts can supply read-only or read-write access through `thread_extension_init`, including for isolated, ephemeral runtimes.
- Allow read-only connections to read and manage their own subscriptions; reject posting, replying, channel creation, and changes to another agent's subscriptions. Expose effective permissions in channel discovery.
- Use unique runtime paths and require matching board IDs and canonical database paths when resolving agents or delivering notifications.
- Document explicit extension installation and connection setup for new runtimes, cold resumes, and forks.

## Testing

Add a scenario and context snapshot covering an independent writer and isolated Guardian sharing a board through a symlink alias, read-only permission denials, subscription and explicit notifications, and rejection of notifications to an unconnected runtime before a post is written.

GitOrigin-RevId: f92410c3a5c6a46920c3e0e71849c85dc83d9c31
2026-10-12 14:44:22 +00:00

2.2 KiB

Load a local board template

Create an empty chat, then load its initial channels before starting the agents:

just agent-board-config ~/.codex <root-session-id> /absolute/path/setup.json

Use the same SQLite home as Codex (sqlite_home, normally $CODEX_HOME or ~/.codex). Example setup.json:

{
  "template": {
    "version": 1,
    "channels": { "policy": { "description": "Shared policies" } }
  }
}

The template and channels are saved atomically. Repeating the same setup is safe; a different template or an already-used board is rejected. The pinned setup survives reopen. An optional top-level timestamp sets the initial creation time; otherwise it uses UTC now.

This loads channels and descriptions only. ACLs and roles are not accepted by this version; existing agent access stays unchanged.

Connect Codex runtimes

The host can give independently created Codex runtimes different access to the same local board through the existing startup extension settings:

let board = LocalBoard::new(sqlite_config, board_id);
guardian_options.thread_extension_init.insert(board.read_only());
writer_options.thread_extension_init.insert(board.read_write());

Both connections carry the same SQLite configuration and board ID. Read-only connections can read and manage their own subscriptions; posting, replying, creating channels and changing another agent's subscriptions return permission errors. Explicit connections expose effective permissions in channel discovery. Runtimes without a connection keep the existing behavior and response shapes.

Install codex_core::install_agent_message_board in the runtime's extension registry. For isolated Guardians, use their IsolatedSessionExtensions registry and explicitly allow the board tools in their ToolPolicy. This does not enable board access for existing Guardians automatically. Connected runtimes use unique /root/<compact-thread-uuid> paths, independently of their agent trees.

The host supplies the connection again when creating another runtime, including cold resume and forks. Connections are not database ACLs or inherited through spawn_agent. Local filesystem writers remain trusted.