Skip to content

Commit 0ce51fe

Browse files
committed
🤖 docs: document ask_user_question in plan mode
Change-Id: I89dc9db6cfc514869bcb6587c1b80e3511b72bf7 Signed-off-by: Thomas Kosiewski <tk@coder.com>
1 parent 69c5719 commit 0ce51fe

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

docs/plan-mode.mdx

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,34 @@ This means you can make edits in your preferred editor, return to mux, send a me
2929

3030
## Plan File Location
3131

32-
Plans are stored in a dedicated directory:
32+
Plans are stored in a dedicated directory under your Mux home:
3333

3434
```
35-
~/.mux/plans/<workspace-id>.md
35+
~/.mux/plans/<project>/<workspace-name>.md
3636
```
3737

38-
The file is created when the agent first writes a plan and persists across sessions.
38+
Notes:
39+
40+
- `<workspace-name>` includes the random suffix (e.g. `feature-x7k2`), so it’s globally unique with high probability.
41+
42+
## ask_user_question (Plan Mode Only)
43+
44+
In plan mode, the agent may call `ask_user_question` to ask up to 4 structured multiple-choice questions when it needs clarification before finalizing a plan.
45+
46+
What you’ll see:
47+
48+
- An inline “tool call card” in the chat with a small form (single-select or multi-select).
49+
- An always-available **Other** option for free-form answers.
50+
51+
How to respond:
52+
53+
- **Recommended:** answer in the form and click **Submit answers**.
54+
- **Optional:** you can also just type a normal chat message. This will **cancel** the pending `ask_user_question` tool call and your message will be sent as a regular chat message.
55+
56+
Availability:
57+
58+
- `ask_user_question` is only registered for the agent in **Plan Mode**.
59+
- In Exec Mode, the agent cannot call `ask_user_question`.
3960

4061
## UI Features
4162

@@ -55,7 +76,7 @@ User: "Add user authentication to the app"
5576
5677
┌─────────────────────────────────────┐
5778
│ Agent reads codebase, writes plan │
58-
│ to ~/.mux/plans/<id>.md
79+
│ to ~/.mux/plans/<project>/<name>.md│
5980
└─────────────────────────────────────┘
6081
6182

0 commit comments

Comments
 (0)