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

codex_codes/
protocol.rs
