codex_codes/
protocol.rs

1//! App-server protocol types for the Codex CLI.
2//!
3//! Every wire type is generated from the upstream JSON Schema bundle by
4//! `scripts/codegen_protocol.py` and lives in [`crate::protocol_generated::types`].
5//! This module re-exports them and adds the JSON-RPC method-name constants
6//! the dispatch layer matches against.
7//!
8//! # Parsing notifications
9//!
10//! Prefer the typed dispatch in [`crate::messages`] over manual `method` checks:
11//!
12//! ```
13//! use codex_codes::{Notification, ServerMessage};
14//!
15//! fn handle(msg: ServerMessage) {
16//!     if let ServerMessage::Notification(Notification::TurnCompleted(c)) = msg {
17//!         println!("Turn on thread {} completed", c.thread_id);
18//!     }
19//! }
20//! ```
21
22pub use crate::protocol_generated::types::*;
23
24/// JSON-RPC method names used by the app-server protocol.
25///
26/// Use these constants when matching on [`crate::ServerMessage::Notification`] or
27/// [`crate::ServerMessage::Request`] method fields to avoid typos.
28pub mod methods {
29    // Client → server requests
30    pub const INITIALIZE: &str = "initialize";
31    pub const INITIALIZED: &str = "initialized";
32    pub const THREAD_START: &str = "thread/start";
33    pub const THREAD_ARCHIVE: &str = "thread/archive";
34    pub const THREAD_DELETE: &str = "thread/delete";
35    pub const TURN_START: &str = "turn/start";
36    pub const TURN_INTERRUPT: &str = "turn/interrupt";
37    pub const TURN_STEER: &str = "turn/steer";
38    pub const THREAD_RESUME: &str = "thread/resume";
39    pub const THREAD_FORK: &str = "thread/fork";
40    pub const THREAD_UNSUBSCRIBE: &str = "thread/unsubscribe";
41    pub const THREAD_NAME_SET: &str = "thread/name/set";
42    pub const THREAD_METADATA_UPDATE: &str = "thread/metadata/update";
43    pub const THREAD_ATTACHMENT_ADD: &str = "thread/attachment/add";
44    pub const THREAD_ATTACHMENT_LIST: &str = "thread/attachment/list";
45    pub const THREAD_ATTACHMENT_REMOVE: &str = "thread/attachment/remove";
46    pub const THREAD_UNARCHIVE: &str = "thread/unarchive";
47    pub const THREAD_COMPACT_START: &str = "thread/compact/start";
48    pub const THREAD_SHELLCOMMAND: &str = "thread/shellCommand";
49    pub const THREAD_APPROVEGUARDIANDENIEDACTION: &str = "thread/approveGuardianDeniedAction";
50    pub const THREAD_LIST: &str = "thread/list";
51    pub const THREAD_LOADED_LIST: &str = "thread/loaded/list";
52    pub const THREAD_READ: &str = "thread/read";
53    pub const THREAD_INJECT_ITEMS: &str = "thread/inject_items";
54    pub const THREAD_ITEMS_LIST: &str = "thread/items/list";
55    pub const THREAD_TURNS_LIST: &str = "thread/turns/list";
56    pub const THREAD_REVERT: &str = "thread/revert";
57    pub const SKILLS_LIST: &str = "skills/list";
58    pub const HOOKS_LIST: &str = "hooks/list";
59    pub const MARKETPLACE_ADD: &str = "marketplace/add";
60    pub const MARKETPLACE_REMOVE: &str = "marketplace/remove";
61    pub const MARKETPLACE_UPGRADE: &str = "marketplace/upgrade";
62    pub const PLUGIN_LIST: &str = "plugin/list";
63    pub const PLUGIN_READ: &str = "plugin/read";
64    pub const PLUGIN_SKILL_READ: &str = "plugin/skill/read";
65    pub const PLUGIN_SHARE_SAVE: &str = "plugin/share/save";
66    pub const PLUGIN_SHARE_UPDATETARGETS: &str = "plugin/share/updateTargets";
67    pub const PLUGIN_SHARE_LIST: &str = "plugin/share/list";
68    pub const PLUGIN_SHARE_CHECKOUT: &str = "plugin/share/checkout";
69    pub const PLUGIN_SHARE_DELETE: &str = "plugin/share/delete";
70    pub const APP_LIST: &str = "app/list";
71    pub const APP_READ: &str = "app/read";
72    pub const APP_INSTALLED: &str = "app/installed";
73    pub const FS_READFILE: &str = "fs/readFile";
74    pub const FS_WRITEFILE: &str = "fs/writeFile";
75    pub const FS_CREATEDIRECTORY: &str = "fs/createDirectory";
76    pub const FS_GETMETADATA: &str = "fs/getMetadata";
77    pub const FS_READDIRECTORY: &str = "fs/readDirectory";
78    pub const FS_REMOVE: &str = "fs/remove";
79    pub const FS_COPY: &str = "fs/copy";
80    pub const FS_WATCH: &str = "fs/watch";
81    pub const FS_UNWATCH: &str = "fs/unwatch";
82    pub const SKILLS_CONFIG_WRITE: &str = "skills/config/write";
83    pub const PLUGIN_INSTALL: &str = "plugin/install";
84    pub const PLUGIN_UNINSTALL: &str = "plugin/uninstall";
85    pub const REVIEW_START: &str = "review/start";
86    pub const MODEL_LIST: &str = "model/list";
87    pub const MODELPROVIDER_CAPABILITIES_READ: &str = "modelProvider/capabilities/read";
88    pub const EXPERIMENTALFEATURE_LIST: &str = "experimentalFeature/list";
89    pub const EXPERIMENTALFEATURE_ENABLEMENT_SET: &str = "experimentalFeature/enablement/set";
90    pub const MCPSERVER_OAUTH_LOGIN: &str = "mcpServer/oauth/login";
91    pub const CONFIG_MCPSERVER_RELOAD: &str = "config/mcpServer/reload";
92    pub const MCPSERVERSTATUS_LIST: &str = "mcpServerStatus/list";
93    pub const MCPSERVER_RESOURCE_READ: &str = "mcpServer/resource/read";
94    pub const MCPSERVER_TOOL_CALL: &str = "mcpServer/tool/call";
95    pub const WINDOWSSANDBOX_SETUPSTART: &str = "windowsSandbox/setupStart";
96    pub const WINDOWSSANDBOX_READINESS: &str = "windowsSandbox/readiness";
97    pub const ACCOUNT_LOGIN_START: &str = "account/login/start";
98    pub const ACCOUNT_LOGIN_CANCEL: &str = "account/login/cancel";
99    pub const ACCOUNT_LOGOUT: &str = "account/logout";
100    pub const ACCOUNT_RATELIMITS_READ: &str = "account/rateLimits/read";
101    pub const ACCOUNT_SENDADDCREDITSNUDGEEMAIL: &str = "account/sendAddCreditsNudgeEmail";
102    pub const FEEDBACK_UPLOAD: &str = "feedback/upload";
103    pub const COMMAND_EXEC: &str = "command/exec";
104    pub const COMMAND_EXEC_WRITE: &str = "command/exec/write";
105    pub const COMMAND_EXEC_TERMINATE: &str = "command/exec/terminate";
106    pub const COMMAND_EXEC_RESIZE: &str = "command/exec/resize";
107    pub const CONFIG_READ: &str = "config/read";
108    pub const EXTERNALAGENTCONFIG_DETECT: &str = "externalAgentConfig/detect";
109    pub const EXTERNALAGENTCONFIG_IMPORT: &str = "externalAgentConfig/import";
110    pub const CONFIG_VALUE_WRITE: &str = "config/value/write";
111    pub const CONFIG_BATCHWRITE: &str = "config/batchWrite";
112    pub const CONFIGREQUIREMENTS_READ: &str = "configRequirements/read";
113    pub const ACCOUNT_READ: &str = "account/read";
114    pub const FUZZYFILESEARCH: &str = "fuzzyFileSearch";
115    pub const ACCOUNT_USAGE_READ: &str = "account/usage/read";
116    pub const PERMISSION_PROFILE_LIST: &str = "permissionProfile/list";
117    pub const PLUGIN_INSTALLED: &str = "plugin/installed";
118    pub const PLUGIN_RECONCILE: &str = "plugin/reconcile";
119    pub const SKILLS_EXTRA_ROOTS_SET: &str = "skills/extraRoots/set";
120    pub const THREAD_GOAL_GET: &str = "thread/goal/get";
121    pub const THREAD_GOAL_SET: &str = "thread/goal/set";
122    pub const THREAD_GOAL_CLEAR: &str = "thread/goal/clear";
123    pub const THREADSECTION_LIST: &str = "threadSection/list";
124    pub const THREADSECTION_CREATE: &str = "threadSection/create";
125    pub const THREADSECTION_UPDATE: &str = "threadSection/update";
126    pub const THREADSECTION_DELETE: &str = "threadSection/delete";
127    pub const THREAD_SECTION_MOVE: &str = "thread/section/move";
128    pub const ACCOUNT_RATELIMITRESETCREDIT_CONSUME: &str = "account/rateLimitResetCredit/consume";
129    pub const ACCOUNT_WORKSPACEMESSAGES_READ: &str = "account/workspaceMessages/read";
130    pub const EXTERNALAGENTCONFIG_IMPORT_READHISTORIES: &str =
131        "externalAgentConfig/import/readHistories";
132    pub const EXTERNALAGENTCONFIG_IMPORT_RECORDHISTORY: &str =
133        "externalAgentConfig/import/recordHistory";
134
135    // Server → client notifications
136    pub const THREAD_STARTED: &str = "thread/started";
137    pub const STRICT_REVIEW_REQUIRED: &str = "autoApprovalReview/strictReviewRequired";
138    pub const PROJECT_CHANGED: &str = "project/changed";
139    pub const THREAD_PROJECT_UPDATED: &str = "thread/project/updated";
140    pub const THREAD_QUEUE_CHANGED: &str = "thread/queue/changed";
141    pub const THREAD_REVERTED: &str = "thread/reverted";
142    pub const MCP_SERVER_EVENT_STREAM: &str = "mcpServer/event/stream/notification";
143    pub const THREAD_STATUS_CHANGED: &str = "thread/status/changed";
144    pub const THREAD_TOKEN_USAGE_UPDATED: &str = "thread/tokenUsage/updated";
145    pub const TURN_STARTED: &str = "turn/started";
146    pub const TURN_COMPLETED: &str = "turn/completed";
147    pub const ITEM_STARTED: &str = "item/started";
148    pub const ITEM_COMPLETED: &str = "item/completed";
149    pub const AGENT_MESSAGE_DELTA: &str = "item/agentMessage/delta";
150    pub const CMD_OUTPUT_DELTA: &str = "item/commandExecution/outputDelta";
151    pub const FILE_CHANGE_OUTPUT_DELTA: &str = "item/fileChange/outputDelta";
152    pub const REASONING_DELTA: &str = "item/reasoning/summaryTextDelta";
153    pub const ERROR: &str = "error";
154    pub const ACCOUNT_RATE_LIMITS_UPDATED: &str = "account/rateLimits/updated";
155    pub const MCP_SERVER_STARTUP_STATUS_UPDATED: &str = "mcpServer/startupStatus/updated";
156    pub const MCP_SERVER_OAUTH_LOGIN_COMPLETED: &str = "mcpServer/oauthLogin/completed";
157    pub const REMOTE_CONTROL_STATUS_CHANGED: &str = "remoteControl/status/changed";
158    pub const FILE_CHANGE_PATCH_UPDATED: &str = "item/fileChange/patchUpdated";
159    pub const PLAN_DELTA: &str = "item/plan/delta";
160    pub const TURN_PLAN_UPDATED: &str = "turn/plan/updated";
161    pub const TURN_DIFF_UPDATED: &str = "turn/diff/updated";
162    pub const REASONING_SUMMARY_PART_ADDED: &str = "item/reasoning/summaryPartAdded";
163    pub const REASONING_TEXT_DELTA: &str = "item/reasoning/textDelta";
164    pub const ACCOUNT_LOGIN_COMPLETED: &str = "account/login/completed";
165    pub const DEPRECATION_NOTICE: &str = "deprecationNotice";
166    pub const GUARDIAN_WARNING: &str = "guardianWarning";
167    pub const WARNING: &str = "warning";
168    pub const THREAD_ARCHIVED: &str = "thread/archived";
169    pub const THREAD_CLOSED: &str = "thread/closed";
170    pub const THREAD_DELETED: &str = "thread/deleted";
171    pub const THREAD_UNARCHIVED: &str = "thread/unarchived";
172    pub const THREAD_GOAL_CLEARED: &str = "thread/goal/cleared";
173    pub const THREAD_NAME_UPDATED: &str = "thread/name/updated";
174    pub const THREAD_ATTACHMENT_UPDATED: &str = "thread/attachment/updated";
175    pub const SKILLS_CHANGED: &str = "skills/changed";
176    pub const FS_CHANGED: &str = "fs/changed";
177    pub const CONFIG_WARNING: &str = "configWarning";
178    pub const ACCOUNT_UPDATED: &str = "account/updated";
179    pub const APP_LIST_UPDATED: &str = "app/list/updated";
180    pub const COMMAND_EXEC_OUTPUT_DELTA: &str = "command/exec/outputDelta";
181    pub const EXTERNAL_AGENT_CONFIG_IMPORT_COMPLETED: &str = "externalAgentConfig/import/completed";
182    pub const FUZZY_FILE_SEARCH_SESSION_COMPLETED: &str = "fuzzyFileSearch/sessionCompleted";
183    pub const FUZZY_FILE_SEARCH_SESSION_UPDATED: &str = "fuzzyFileSearch/sessionUpdated";
184    pub const HOOK_COMPLETED: &str = "hook/completed";
185    pub const HOOK_STARTED: &str = "hook/started";
186    pub const ITEM_AUTO_APPROVAL_REVIEW_COMPLETED: &str = "item/autoApprovalReview/completed";
187    pub const ITEM_AUTO_APPROVAL_REVIEW_STARTED: &str = "item/autoApprovalReview/started";
188    pub const ITEM_COMMAND_EXEC_TERMINAL_INTERACTION: &str =
189        "item/commandExecution/terminalInteraction";
190    pub const ITEM_MCP_TOOL_CALL_PROGRESS: &str = "item/mcpToolCall/progress";
191    pub const MODEL_REROUTED: &str = "model/rerouted";
192    pub const MODEL_VERIFICATION: &str = "model/verification";
193    pub const PROCESS_EXITED: &str = "process/exited";
194    pub const PROCESS_OUTPUT_DELTA: &str = "process/outputDelta";
195    pub const SERVER_REQUEST_RESOLVED: &str = "serverRequest/resolved";
196    pub const THREAD_COMPACTED: &str = "thread/compacted";
197    pub const THREAD_GOAL_UPDATED: &str = "thread/goal/updated";
198    pub const THREAD_REALTIME_CLOSED: &str = "thread/realtime/closed";
199    pub const THREAD_REALTIME_ERROR: &str = "thread/realtime/error";
200    pub const THREAD_REALTIME_ITEM_ADDED: &str = "thread/realtime/itemAdded";
201    pub const THREAD_REALTIME_OUTPUT_AUDIO_DELTA: &str = "thread/realtime/outputAudio/delta";
202    pub const THREAD_REALTIME_SDP: &str = "thread/realtime/sdp";
203    pub const THREAD_REALTIME_STARTED: &str = "thread/realtime/started";
204    pub const THREAD_REALTIME_TRANSCRIPT_DELTA: &str = "thread/realtime/transcript/delta";
205    pub const THREAD_REALTIME_TRANSCRIPT_DONE: &str = "thread/realtime/transcript/done";
206    pub const THREAD_REALTIME_ITEM_STARTED: &str = "thread/realtime/item/started";
207    pub const THREAD_REALTIME_ITEM_COMPLETED: &str = "thread/realtime/item/completed";
208    pub const THREAD_REALTIME_ITEM_TRANSCRIPT_DELTA: &str = "thread/realtime/item/transcript/delta";
209    pub const MODEL_PROVIDER_AUTH_RECOVERY_STARTED: &str = "modelProvider/authRecoveryStarted";
210    pub const MODEL_PROVIDER_AUTH_RECOVERY_COMPLETED: &str = "modelProvider/authRecoveryCompleted";
211    pub const WINDOWS_WORLD_WRITABLE_WARNING: &str = "windows/worldWritableWarning";
212    pub const WINDOWS_SANDBOX_SETUP_COMPLETED: &str = "windowsSandbox/setupCompleted";
213    pub const THREAD_SETTINGS_UPDATED: &str = "thread/settings/updated";
214    pub const TURN_MODERATION_METADATA: &str = "turn/moderationMetadata";
215    pub const EXTERNAL_AGENT_CONFIG_IMPORT_PROGRESS: &str = "externalAgentConfig/import/progress";
216    pub const MODEL_SAFETY_BUFFERING_UPDATED: &str = "model/safetyBuffering/updated";
217    pub const THREAD_ENVIRONMENT_CONNECTED: &str = "thread/environment/connected";
218    pub const THREAD_ENVIRONMENT_DISCONNECTED: &str = "thread/environment/disconnected";
219
220    // Server → client requests (approval flow, v2 envelope)
221    pub const CMD_EXEC_APPROVAL: &str = "item/commandExecution/requestApproval";
222    pub const FILE_CHANGE_APPROVAL: &str = "item/fileChange/requestApproval";
223    pub const TOOL_REQUEST_USER_INPUT: &str = "item/tool/requestUserInput";
224    pub const MCP_SERVER_ELICITATION_REQUEST: &str = "mcpServer/elicitation/request";
225    pub const PERMISSIONS_REQUEST_APPROVAL: &str = "item/permissions/requestApproval";
226    pub const ITEM_TOOL_CALL: &str = "item/tool/call";
227    pub const CHATGPT_AUTH_TOKENS_REFRESH: &str = "account/chatgptAuthTokens/refresh";
228    pub const ATTESTATION_GENERATE: &str = "attestation/generate";
229    pub const APPLY_PATCH_APPROVAL: &str = "applyPatchApproval";
230    pub const EXEC_COMMAND_APPROVAL: &str = "execCommandApproval";
231}
232
233// ──────────────────────────────────────────────────────────────────────────
234// Ergonomic constructors over the generated wire types.
235//
236// The types themselves are code-generated from the upstream schema; these
237// hand-written impls live here so they survive regeneration. (`Default` for
238// params whose fields are all serde-defaultable is derived by the codegen
239// itself since #203.) They cover one pain point for downstream consumers:
240//
241//   * `accept` / `decline` / `approved` / `denied` constructors for the
242//     approval-response payloads, so callers don't hand-roll `serde_json`
243//     objects and can't typo the wire `decision` string.
244// ──────────────────────────────────────────────────────────────────────────
245
246impl FileChangeRequestApprovalResponse {
247    /// Approve this file-change request (`{"decision":"accept"}`).
248    pub fn accept() -> Self {
249        Self {
250            decision: FileChangeApprovalDecision::Accept,
251        }
252    }
253
254    /// Approve this and future file changes for the session.
255    pub fn accept_for_session() -> Self {
256        Self {
257            decision: FileChangeApprovalDecision::AcceptForSession,
258        }
259    }
260
261    /// Decline this file-change request (`{"decision":"decline"}`).
262    pub fn decline() -> Self {
263        Self {
264            decision: FileChangeApprovalDecision::Decline,
265        }
266    }
267
268    /// Cancel the turn in response to this request.
269    pub fn cancel() -> Self {
270        Self {
271            decision: FileChangeApprovalDecision::Cancel,
272        }
273    }
274}
275
276impl CommandExecutionRequestApprovalResponse {
277    /// Approve this command execution (`{"decision":"accept"}`).
278    pub fn accept() -> Self {
279        Self {
280            decision: CommandExecutionApprovalDecision::Accept,
281        }
282    }
283
284    /// Approve this and future command executions for the session.
285    pub fn accept_for_session() -> Self {
286        Self {
287            decision: CommandExecutionApprovalDecision::AcceptForSession,
288        }
289    }
290
291    /// Decline this command execution (`{"decision":"decline"}`).
292    pub fn decline() -> Self {
293        Self {
294            decision: CommandExecutionApprovalDecision::Decline,
295        }
296    }
297
298    /// Cancel the turn in response to this request.
299    pub fn cancel() -> Self {
300        Self {
301            decision: CommandExecutionApprovalDecision::Cancel,
302        }
303    }
304}
305
306impl ExecCommandApprovalResponse {
307    /// Approve the exec command (`{"decision":"approved"}`).
308    pub fn approved() -> Self {
309        Self {
310            decision: ReviewDecision::Approved,
311        }
312    }
313
314    /// Approve the exec command for the rest of the session.
315    pub fn approved_for_session() -> Self {
316        Self {
317            decision: ReviewDecision::ApprovedForSession,
318        }
319    }
320
321    /// Deny the exec command (`{"decision":{"denied":{"rejection":...}}}`).
322    pub fn denied(rejection: impl Into<String>) -> Self {
323        Self {
324            decision: ReviewDecision::Denied {
325                rejection: rejection.into(),
326            },
327        }
328    }
329
330    /// Abort the turn in response to the request.
331    pub fn abort() -> Self {
332        Self {
333            decision: ReviewDecision::Abort,
334        }
335    }
336}
337
338impl ApplyPatchApprovalResponse {
339    /// Approve the patch (`{"decision":"approved"}`).
340    pub fn approved() -> Self {
341        Self {
342            decision: ReviewDecision::Approved,
343        }
344    }
345
346    /// Approve this and future patches for the session.
347    pub fn approved_for_session() -> Self {
348        Self {
349            decision: ReviewDecision::ApprovedForSession,
350        }
351    }
352
353    /// Deny the patch (`{"decision":{"denied":{"rejection":...}}}`).
354    pub fn denied(rejection: impl Into<String>) -> Self {
355        Self {
356            decision: ReviewDecision::Denied {
357                rejection: rejection.into(),
358            },
359        }
360    }
361
362    /// Abort the turn in response to the request.
363    pub fn abort() -> Self {
364        Self {
365            decision: ReviewDecision::Abort,
366        }
367    }
368}
369
370#[cfg(test)]
371mod tests {
372    use super::*;
373
374    #[test]
375    fn thread_start_params_default_is_empty_object() {
376        let p = ThreadStartParams::default();
377        assert_eq!(serde_json::to_value(&p).unwrap(), serde_json::json!({}));
378    }
379
380    #[test]
381    fn turn_start_params_default_round_trips() {
382        let p = TurnStartParams::default();
383        let v = serde_json::to_value(&p).unwrap();
384        // thread_id + input are required-but-defaulted; everything else omits.
385        assert_eq!(v["threadId"], "");
386        assert_eq!(v["input"], serde_json::json!([]));
387    }
388
389    #[test]
390    fn thread_resume_and_fork_params_default() {
391        let _ = ThreadResumeParams::default();
392        let _ = ThreadForkParams::default();
393    }
394
395    #[test]
396    fn file_change_approval_response_wire_shape() {
397        assert_eq!(
398            serde_json::to_value(FileChangeRequestApprovalResponse::accept()).unwrap(),
399            serde_json::json!({"decision": "accept"})
400        );
401        assert_eq!(
402            serde_json::to_value(FileChangeRequestApprovalResponse::decline()).unwrap(),
403            serde_json::json!({"decision": "decline"})
404        );
405    }
406
407    #[test]
408    fn command_execution_approval_response_wire_shape() {
409        assert_eq!(
410            serde_json::to_value(CommandExecutionRequestApprovalResponse::accept()).unwrap(),
411            serde_json::json!({"decision": "accept"})
412        );
413        assert_eq!(
414            serde_json::to_value(CommandExecutionRequestApprovalResponse::cancel()).unwrap(),
415            serde_json::json!({"decision": "cancel"})
416        );
417    }
418
419    #[test]
420    fn exec_and_apply_patch_approval_response_wire_shape() {
421        assert_eq!(
422            serde_json::to_value(ExecCommandApprovalResponse::approved()).unwrap(),
423            serde_json::json!({"decision": "approved"})
424        );
425        assert_eq!(
426            serde_json::to_value(ApplyPatchApprovalResponse::denied("keep the original file"))
427                .unwrap(),
428            serde_json::json!({"decision": {"denied": {"rejection": "keep the original file"}}})
429        );
430    }
431}
codex_codes/protocol.rs

codex_codes/
protocol.rs
