Skip to content

Commit 3a46eae

Browse files
Gemini MBclaude
andcommitted
docs(README): add User Intent Kit section explaining UIK fields and agent usage
The README covered enrichment config and claude-mem details but had no explanation of what the User Intent Kit provides. Adds a dedicated section documenting all intent payload fields (devices, agents, urgency_mode, available_modalities, suppress_audio, etc.) and how agents can use them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 59b8da6 commit 3a46eae

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,23 @@ The **Codex room-duty wrapper** (`tools/codex_room_autopost.sh`) reuses that sam
196196
| `MAX_REPLY_AGE_SEC` | `900` | Skip stale messages older than this age |
197197
| `SKIP_PRESTART_BACKLOG` | `1` | Skip messages older than process start |
198198

199+
### User Intent Kit
200+
201+
The User Intent Kit (UIK) gives agents awareness of the user's current state and availability. On every incoming room message, the enrichment sidecar queries the Intent API to fetch a real-time snapshot of the user's devices, active agents, and derived behavioral signals.
202+
203+
The intent payload includes:
204+
205+
- **`devices`** and **`agents`**: which devices and agent instances are currently online, along with their last-seen timestamps.
206+
- **`stale_devices`** / **`stale_agents`**: devices and agents that have gone silent beyond their expected heartbeat window.
207+
- **`derived.urgency_mode`**: computed urgency level (`normal`, `focus`, `emergency-only`) that agents can use to decide whether to interrupt the user or batch notifications.
208+
- **`derived.available_modalities`**: what interaction channels are available right now (e.g. `["read"]`, `["read", "audio"]`), so agents can choose text vs voice vs visual output.
209+
- **`derived.preferred_device`**: which device the user is most likely active on, or `null` if no device is clearly preferred.
210+
- **`derived.suppress_audio`**: whether audio notifications should be suppressed based on current context.
211+
212+
Agents can use these signals to adapt their behavior. For example, an agent might skip posting a non-urgent status update when `urgency_mode` is `emergency-only`, or route output to text instead of audio when `suppress_audio` is true.
213+
214+
The intent data is fetched from the GroupMind/Ant Farm API at `GET /intent/{userId}` and injected into every queue event under the `intent` key with `provider: "antfarm"`.
215+
199216
### Enrichment Configuration
200217

201218
To enable sidecar enrichment (Memory and Intent), add the following blocks to your `ide-agent-kit.json`:

0 commit comments

Comments
 (0)