@@ -24,30 +24,17 @@ subdirectory that Claude is working in. If omitted, the server uses
2424
2525Prefer these tools in normal Claude usage:
2626
27- - ` ask_codex ` - one blocking Codex task.
28- - ` ask_codex_parallel ` - several independent blocking Codex tasks.
29- - ` run_agents_aggregate ` - parallel tasks plus deterministic aggregation.
30- - ` start_codex_session ` - create a persistent session and wait for the first turn.
31- - ` continue_codex_session ` - send another prompt into an existing session.
32- - ` start_codex_session_async ` - start a persistent session and return immediately.
33- - ` send_codex_session_prompt ` - queue a normal follow-up prompt.
34- - ` steer_codex_session ` - steer the active app-server turn when supported.
35- - ` get_codex_session ` and ` wait_codex_session ` - inspect or wait on sessions.
36-
37- Lower-level compatibility tools remain available:
38-
39- - ` run_agent `
40- - ` run_agents `
41- - ` start_agent_run `
42- - ` start_agents_run `
43- - ` get_agent_run `
44- - ` wait_agent_run `
45- - ` cancel_agent_run `
46- - ` start_session `
47- - ` send_session_prompt `
48- - ` get_session `
49- - ` list_sessions `
50- - ` cancel_session `
27+ - ` codex_task ` - one Task-like Codex subagent with an answer-first result.
28+ - ` codex_task_group ` - several independent Task-like Codex subagents in parallel.
29+ - ` codex_session_start ` - start a persistent session and return a session id.
30+ - ` codex_session_prompt ` - send another prompt into an existing session.
31+ - ` codex_session_steer ` - steer the active app-server turn when supported.
32+ - ` codex_session_status ` and ` codex_session_wait ` - inspect or wait on sessions.
33+ - ` codex_sessions ` , ` codex_session_recover ` , and ` codex_session_cancel ` - manage session lifecycle.
34+
35+ Legacy compatibility tools are hidden by default. Set
36+ ` CODEX_SUBAGENTS_ENABLE_LEGACY_TOOLS=1 ` only for older clients that still call
37+ pre-refactor names such as ` ask_codex ` , ` run_agent ` , or ` start_session ` .
5138
5239Diagnostics tools:
5340
@@ -63,15 +50,13 @@ Use this decision path when writing prompts or debugging Claude tool choice:
6350
6451| User intent | Best tool |
6552| --- | --- |
66- | One normal read-only second opinion | ` ask_codex ` |
67- | Two or more independent workstreams | ` ask_codex_parallel ` |
68- | Several agents plus a merged summary | ` run_agents_aggregate ` |
69- | Same Codex agent should keep context | ` start_codex_session ` , then ` continue_codex_session ` |
70- | Long first turn, user wants to keep working | ` start_codex_session_async ` |
71- | Add a normal follow-up to a running session | ` send_codex_session_prompt ` |
72- | Redirect the active app-server turn | ` steer_codex_session ` |
73- | Recover a session after Claude/MCP restart | ` recover_codex_session ` |
74- | Slow one-shot job that need not be durable | ` start_agent_run ` |
53+ | One normal read-only second opinion | ` codex_task ` |
54+ | Two or more independent workstreams | ` codex_task_group ` |
55+ | Same Codex agent should keep context | ` codex_session_start ` , then ` codex_session_prompt ` |
56+ | Long first turn, user wants to keep working | ` codex_session_start ` |
57+ | Add a normal follow-up to a running session | ` codex_session_prompt ` |
58+ | Redirect the active app-server turn | ` codex_session_steer ` |
59+ | Recover a session after Claude/MCP restart | ` codex_session_recover ` |
7560
7661When in doubt, ask Claude to call ` codex_choose_tool ` before delegating.
7762
@@ -87,9 +72,9 @@ Representative tool arguments:
8772
8873``` json
8974{
90- "task" : " Review the MCP server read-only. Return the top reliability risks with file paths and line references." ,
75+ "description" : " Review MCP server reliability" ,
76+ "prompt" : " Review the MCP server read-only. Return the top reliability risks with file paths and line references." ,
9177 "project_dir" : " /path/to/project" ,
92- "model_preset" : " spark" ,
9378 "reasoning_effort" : " medium"
9479}
9580```
@@ -109,22 +94,24 @@ Representative tool arguments:
10994 "tasks" : [
11095 {
11196 "name" : " api" ,
112- "task" : " Review MCP tool schemas and runtime behavior read-only. Return concrete risks with paths." ,
97+ "description" : " Review API behavior" ,
98+ "prompt" : " Review MCP tool schemas and runtime behavior read-only. Return concrete risks with paths." ,
11399 "project_dir" : " /path/to/project"
114100 },
115101 {
116102 "name" : " tests" ,
117- "task" : " Review test coverage read-only. Identify missing scenarios with paths." ,
103+ "description" : " Review tests" ,
104+ "prompt" : " Review test coverage read-only. Identify missing scenarios with paths." ,
118105 "project_dir" : " /path/to/project"
119106 },
120107 {
121108 "name" : " security" ,
122- "task" : " Review sandboxing, env forwarding, and logging read-only. Return concrete risks with paths." ,
109+ "description" : " Review security posture" ,
110+ "prompt" : " Review sandboxing, env forwarding, and logging read-only. Return concrete risks with paths." ,
123111 "project_dir" : " /path/to/project"
124112 }
125113 ],
126114 "max_parallel" : 3 ,
127- "model_preset" : " spark" ,
128115 "reasoning_effort" : " medium"
129116}
130117```
@@ -135,14 +122,14 @@ Use a persistent session when Codex should keep context across prompts.
135122
136123``` json
137124{
138- "task" : " Investigate the session manager read-only. Keep a compact working map of the code." ,
125+ "description" : " Investigate session manager" ,
126+ "prompt" : " Investigate the session manager read-only. Keep a compact working map of the code." ,
139127 "project_dir" : " /path/to/project" ,
140- "model_preset" : " spark" ,
141128 "reasoning_effort" : " medium"
142129}
143130```
144131
145- For a long-running first turn, use ` start_codex_session_async ` . Then:
132+ ` codex_session_start ` returns a session id immediately by default . Then:
146133
147134``` json
148135{
@@ -156,7 +143,7 @@ To steer an active app-server turn:
156143``` json
157144{
158145 "session_id" : " session-..." ,
159- "steering_prompt " : " Prioritize app-server recovery and ignore UI/documentation polish."
146+ "prompt " : " Prioritize app-server recovery and ignore UI/documentation polish."
160147}
161148```
162149
@@ -165,8 +152,10 @@ protocol and steering becomes a high-priority queued turn.
165152
166153## Spark And Reasoning
167154
168- Use ` model_preset: "spark" ` for fast, focused Codex work. Exact ` model ` still
169- wins when both ` model ` and ` model_preset ` are provided.
155+ Do not use ` model_preset: "spark" ` by default. Use Spark only when the user asks
156+ for Spark or when a quick focused sidecar check is clearly more appropriate than
157+ the default Codex model. Exact ` model ` still wins when both ` model ` and
158+ ` model_preset ` are provided.
170159
171160Recommended reasoning:
172161
0 commit comments