Skip to content

Commit 2025835

Browse files
committed
Update app-server events doc
1 parent 6679c23 commit 2025835

1 file changed

Lines changed: 45 additions & 29 deletions

File tree

docs/app-server-events.md

Lines changed: 45 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# App-Server Events Reference (Codex `f72ab43fd193b31208cd3c306293b1b71a52a709`)
1+
# App-Server Events Reference (Codex `5d4303510cc35571ae99a0a4a7d6ac40ccc03089`)
22

33
This document helps agents quickly answer:
44
- Which app-server events CodexMonitor supports right now.
@@ -50,43 +50,50 @@ Primary outgoing request layer:
5050
- `src-tauri/src/codex/mod.rs`
5151
- `src-tauri/src/bin/codex_monitor_daemon.rs`
5252

53-
## Supported Events (Current)
53+
## Supported Notifications (Codex v2)
5454

55-
These are the app-server methods currently supported in
56-
`src/utils/appServerEvents.ts` (`SUPPORTED_APP_SERVER_METHODS`) and then either
57-
routed in `useAppServerEvents.ts` or handled in feature-specific subscriptions.
55+
These are the current Codex v2 `ServerNotification` methods that CodexMonitor
56+
supports in `src/utils/appServerEvents.ts` (`SUPPORTED_APP_SERVER_METHODS`) and
57+
then either routes in `useAppServerEvents.ts` or handles in feature-specific
58+
subscriptions.
5859

60+
- `account/login/completed`
61+
- `account/rateLimits/updated`
62+
- `account/updated`
5963
- `app/list/updated`
60-
- `codex/connected`
61-
- `*requestApproval` methods (matched via
62-
`isApprovalRequestMethod(method)`; suffix check)
63-
- `item/tool/requestUserInput`
64+
- `error`
6465
- `item/agentMessage/delta`
65-
- `turn/started`
66-
- `thread/started`
66+
- `item/commandExecution/outputDelta`
67+
- `item/commandExecution/terminalInteraction`
68+
- `item/completed`
69+
- `item/fileChange/outputDelta`
70+
- `item/plan/delta`
71+
- `item/reasoning/summaryPartAdded`
72+
- `item/reasoning/summaryTextDelta`
73+
- `item/reasoning/textDelta`
74+
- `item/started`
6775
- `thread/archived`
6876
- `thread/closed`
6977
- `thread/name/updated`
78+
- `thread/started`
7079
- `thread/status/changed`
80+
- `thread/tokenUsage/updated`
7181
- `thread/unarchived`
72-
- `codex/backgroundThread`
73-
- `error`
7482
- `turn/completed`
75-
- `turn/plan/updated`
7683
- `turn/diff/updated`
77-
- `thread/tokenUsage/updated`
78-
- `account/rateLimits/updated`
79-
- `account/updated`
80-
- `account/login/completed`
81-
- `item/started`
82-
- `item/completed`
83-
- `item/reasoning/summaryTextDelta`
84-
- `item/reasoning/summaryPartAdded`
85-
- `item/reasoning/textDelta`
86-
- `item/plan/delta`
87-
- `item/commandExecution/outputDelta`
88-
- `item/commandExecution/terminalInteraction`
89-
- `item/fileChange/outputDelta`
84+
- `turn/plan/updated`
85+
- `turn/started`
86+
87+
## Additional Stream Methods Handled In CodexMonitor
88+
89+
These arrive on the same frontend event stream but are not Codex v2
90+
`ServerNotification` methods:
91+
92+
- `item/commandExecution/requestApproval` and `item/fileChange/requestApproval`
93+
via suffix match in `isApprovalRequestMethod(method)`
94+
- `item/tool/requestUserInput` (a Codex v2 server request, not a notification)
95+
- `codex/backgroundThread` (CodexMonitor synthetic bridge event)
96+
- `codex/connected` (CodexMonitor synthetic bridge event)
9097
- `codex/event/skills_update_available` (handled via
9198
`isSkillsUpdateAvailableEvent(...)` in `useSkills.ts`)
9299

@@ -110,6 +117,8 @@ events are currently not routed:
110117

111118
- `configWarning`
112119
- `deprecationNotice`
120+
- `fuzzyFileSearch/sessionCompleted`
121+
- `fuzzyFileSearch/sessionUpdated`
113122
- `item/mcpToolCall/progress`
114123
- `mcpServer/oauthLogin/completed`
115124
- `model/rerouted`
@@ -165,8 +174,13 @@ Compared against Codex v2 request methods, CodexMonitor currently does not send:
165174
- `externalAgentConfig/detect`
166175
- `externalAgentConfig/import`
167176
- `feedback/upload`
177+
- `fuzzyFileSearch/sessionStart`
178+
- `fuzzyFileSearch/sessionStop`
179+
- `fuzzyFileSearch/sessionUpdate`
168180
- `mcpServer/oauth/login`
169181
- `mock/experimentalMethod`
182+
- `plugin/install`
183+
- `plugin/list`
170184
- `skills/config/write`
171185
- `skills/remote/export`
172186
- `skills/remote/list`
@@ -187,13 +201,15 @@ Compared against Codex v2 request methods, CodexMonitor currently does not send:
187201

188202
Supported server requests:
189203

190-
- `*requestApproval` methods (handled via suffix match in `isApprovalRequestMethod(method)`)
204+
- `item/commandExecution/requestApproval`
205+
- `item/fileChange/requestApproval`
191206
- `item/tool/requestUserInput`
192207

193208
Missing server requests:
194209

195210
- `item/tool/call`
196211
- `account/chatgptAuthTokens/refresh`
212+
- `mcpServer/elicitation/request`
197213

198214
## Where To Look In ../Codex
199215

@@ -215,7 +231,7 @@ Use this workflow to update the lists above:
215231
1. Get the current Codex hash:
216232
- `git -C ../Codex fetch --all --prune && git -C ../Codex rev-parse origin/main`
217233
2. List Codex v2 notification methods:
218-
- `(git -C ../Codex show origin/main:codex-rs/app-server-protocol/src/protocol/common.rs | rg -N -o '=>\\s*\"[^\"]+\"\\s*\\(v2::[^)]*Notification\\)' | sed -E 's/.*\"([^\"]+)\".*/\\1/'; printf '%s\\n' 'account/login/completed') | sort -u`
234+
- `git -C ../Codex show origin/main:codex-rs/app-server-protocol/src/protocol/common.rs | awk '/server_notification_definitions! \\{/,/client_notification_definitions! \\{/' | rg -N -o '=>\\s*\"[^\"]+\"|rename = \"[^\"]+\"' | sed -E 's/.*\"([^\"]+)\".*/\\1/' | sort -u`
219235
3. List CodexMonitor routed methods:
220236
- `rg -n \"SUPPORTED_APP_SERVER_METHODS\" src/utils/appServerEvents.ts`
221237
4. Update the Supported and Missing sections.

0 commit comments

Comments
 (0)