Skip to content

Commit 62c4d15

Browse files
committed
docs: Enhance auto-approving actions and task todo list documentation with new features and safety guidelines
1 parent 88b692b commit 62c4d15

12 files changed

+167
-268
lines changed

docs/features/auto-approving-actions.mdx

Lines changed: 138 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@ Click the toolbar to expand it and configure individual permissions:
4545

4646
*Prompt text box and Expanded toolbar with all options*
4747

48+
### API Request Limit
49+
50+
The toolbar includes an input field to set the maximum number of API requests Roo can make automatically:
51+
52+
- **Purpose**: Prevents runaway API usage and unexpected costs
53+
- **Default**: No limit (empty field)
54+
- **Recommended**: Set a reasonable limit based on your task complexity (e.g., 50-100 for most tasks)
55+
- **How it works**: Once the limit is reached, Roo will pause and ask for permission to continue
56+
57+
This safety feature is particularly useful when:
58+
- Working with expensive API models
59+
- Testing new workflows
60+
- Letting Roo work autonomously for extended periods
61+
4862
### Available Permissions
4963

5064
| Permission | What it does | Risk level |
@@ -58,6 +72,7 @@ Click the toolbar to expand it and configure individual permissions:
5872
| **Create & complete subtasks** | Manages subtasks without confirmation | Low |
5973
| **Retry failed requests** | Automatically retries failed API requests | Low |
6074
| **Answer follow-up questions** | Selects default answer for follow-up questions| Low |
75+
| **Update todo list** | Automatically updates task progress | Low |
6176

6277
---
6378

@@ -69,10 +84,21 @@ The leftmost checkbox works as a master toggle:
6984

7085
*Master toggle (checkbox) controls all auto-approve permissions at once*
7186

87+
**How it works:**
88+
- **Checked**: Activates all configured auto-approve permissions
89+
- **Unchecked**: Temporarily disables all auto-approvals without changing individual settings
90+
- **Important**: Individual permission settings are preserved when toggling
91+
92+
This means you can:
93+
1. Configure your preferred permissions once
94+
2. Use the master toggle to quickly enable/disable them all
95+
3. Your configuration remains intact for next time
96+
7297
Use the master toggle when:
7398
- Working in sensitive code (turn off)
7499
- Doing rapid development (turn on)
75100
- Switching between exploration and editing tasks
101+
- Temporarily pausing automation without losing settings
76102

77103
---
78104

@@ -87,42 +113,65 @@ To access these settings:
87113
1. Click <Codicon name="gear" /> in the top-right corner
88114
2. Navigate to Auto-Approve Settings
89115

90-
<img src="/img/auto-approving-actions/auto-approving-actions-4.png" alt="Settings panel auto-approve options" width="550" />
91-
116+
<img src="/img/auto-approving-actions/auto-approving-actions-19.png" alt="Settings panel auto-approve options" width="550" />
92117
*Complete settings panel view*
93118

94119
### Read Operations
95120

96-
:::caution Read Operations
97-
<img src="/img/auto-approving-actions/auto-approving-actions-6.png" alt="Read-only operations setting" width="550" />
121+
:::info Read Operations (Risk: Medium)
122+
123+
<img src="/img/auto-approving-actions/auto-approving-actions-3.png" alt="Read-only operations setting" width="550" />
98124

99125
**Setting:** "Always approve read-only operations"
100126

101127
**Description:** "When enabled, Roo will automatically view directory contents and read files without requiring you to click the Approve button."
102128

129+
**Additional option:**
130+
- **Include files outside workspace:** Allow Roo to read files outside the current workspace directory
131+
103132
**Risk level:** Medium
104133

105134
While this setting only allows reading files (not modifying them), it could potentially expose sensitive data. Still recommended as a starting point for most users, but be mindful of what files Roo can access.
135+
136+
#### Workspace Boundary Protection
137+
138+
By default, Roo can only read files within your current workspace directory. The "Include files outside workspace" option extends read access beyond the workspace boundary. Consider the security implications:
139+
140+
- **Default (unchecked)**: Roo can only read files in your project directory
141+
- **Enabled**: Roo can read any file on your system that you have access to
142+
- **Recommendation**: Keep disabled unless you specifically need Roo to access external files
106143
:::
107144

108145
### Write Operations
109146

110-
:::caution Write Operations
111-
<img src="/img/auto-approving-actions/auto-approving-actions-7.png" alt="Write operations setting with delay slider" width="550" />
147+
:::caution Write Operations (Risk: High)
148+
<img src="/img/auto-approving-actions/auto-approving-actions-16.png" alt="Write operations setting with delay slider" width="550" />
112149

113150
**Setting:** "Always approve write operations"
114151

115152
**Description:** "Automatically create and edit files without requiring approval"
116153

117-
**Delay slider:** "Delay after writes to allow diagnostics to detect potential problems" (Default: 1000ms)
154+
**Delay slider:** "Delay after writes to allow diagnostics to detect potential problems" (Default: 0ms)
155+
156+
**Additional options:**
157+
- **Include files outside workspace:** Allow Roo to modify files outside the current workspace directory
158+
- **Include protected files:** Allow Roo to modify files normally protected by .rooignore and .roo/ directory
118159

119160
**Risk level:** High
120161

121162
This setting allows Roo to modify your files without confirmation. The delay timer is crucial:
122163
- Higher values (2000ms+): Recommended for complex projects where diagnostics take longer
123-
- Default (1000ms): Suitable for most projects
124-
- Lower values: Use only when speed is critical and you're in a controlled environment
125-
- Zero: No delay for diagnostics (not recommended for critical code)
164+
- Default (0ms): No delay - use when speed is critical
165+
- 1000ms: Suitable for most projects with active diagnostics
166+
- Lower values: Use only when in a controlled environment
167+
168+
#### Security Boundaries
169+
170+
The write operations setting includes two important security controls:
171+
172+
1. **Workspace Boundary Protection**: By default, Roo can only modify files within your current workspace. Enable "Include files outside workspace" with extreme caution.
173+
174+
2. **Protected Files**: Files in .rooignore and the .roo/ directory are protected by default. The "Include protected files" option bypasses this protection - use only when necessary.
126175

127176
#### Write Delay & Problems Pane Integration
128177

@@ -146,8 +195,7 @@ This works like a human developer pausing to check for errors after changing cod
146195

147196
### Browser Actions
148197

149-
:::info Browser Actions
150-
<img src="/img/auto-approving-actions/auto-approving-actions-8.png" alt="Browser actions setting" width="550" />
198+
:::info Browser Actions (Risk: Medium)
151199

152200
**Setting:** "Always approve browser actions"
153201

@@ -167,8 +215,8 @@ Consider the security implications of allowing automated browser access.
167215

168216
### API Requests
169217

170-
:::info API Requests
171-
<img src="/img/auto-approving-actions/auto-approving-actions-9.png" alt="API requests retry setting with delay slider" width="550" />
218+
:::info API Requests (Risk: Low)
219+
<img src="/img/auto-approving-actions/auto-approving-actions-17.png" alt="API requests retry setting with delay slider" width="550" />
172220

173221
**Setting:** "Always retry failed API requests"
174222

@@ -185,22 +233,32 @@ This setting automatically retries API calls when they fail. The delay controls
185233

186234
### MCP Tools
187235

188-
:::caution MCP Tools
189-
<img src="/img/auto-approving-actions/auto-approving-actions-10.png" alt="MCP tools setting" width="550" />
236+
:::caution MCP Tools (Risk: Medium-High)
190237

191238
**Setting:** "Always approve MCP tools"
192239

193240
**Description:** "Enable auto-approval of individual MCP tools in the MCP Servers view (requires both this setting and the tool's individual 'Always allow' checkbox)"
194241

195242
**Risk level:** Medium-High (depends on configured MCP tools)
196243

197-
This setting works in conjunction with individual tool permissions in the MCP Servers view. Both this global setting and the tool-specific permission must be enabled for auto-approval.
244+
This setting requires a two-step permission process for security:
245+
246+
1. **Enable this global setting** - Acts as a master switch for all MCP tool auto-approval
247+
2. **Enable individual tool permissions** - In the MCP Servers view, check "Always allow" for specific tools
248+
249+
**Important:** Both permissions must be active for a tool to auto-approve. This dual-permission system ensures you maintain granular control over which MCP tools can execute without confirmation.
250+
251+
Example workflow:
252+
- Enable "Always approve MCP tools" in settings
253+
- Navigate to MCP Servers view
254+
- Find the specific tool (e.g., filesystem operations)
255+
- Check its "Always allow" checkbox
256+
- Only then will that specific tool auto-approve
198257
:::
199258

200259
### Mode Switching
201260

202-
:::info Mode Switching
203-
<img src="/img/auto-approving-actions/auto-approving-actions-11.png" alt="Mode switching setting" width="550" />
261+
:::info Mode Switching (Risk: Low)
204262

205263
**Setting:** "Always approve mode switching"
206264

@@ -213,8 +271,7 @@ Allows Roo to change between different modes (Code, Architect, etc.) without ask
213271

214272
### Subtasks
215273

216-
:::info Subtasks
217-
<img src="/img/auto-approving-actions/auto-approving-actions-12.png" alt="Subtasks setting" width="550" />
274+
:::info Subtasks (Risk: Low)
218275

219276
**Setting:** "Always approve creation & completion of subtasks"
220277

@@ -227,8 +284,8 @@ Enables Roo to create and complete subtasks automatically. This relates to workf
227284

228285
### Command Execution
229286

230-
:::caution Command Execution
231-
<img src="/img/auto-approving-actions/auto-approving-actions-13.png" alt="Command execution setting with whitelist interface" width="550" />
287+
:::caution Command Execution (Risk: High)
288+
<img src="/img/auto-approving-actions/auto-approving-actions-18.png" alt="Command execution setting with whitelist interface" width="550" />
232289

233290
**Setting:** "Always approve allowed execute operations"
234291

@@ -246,23 +303,77 @@ This setting allows terminal command execution with controls. While risky, the w
246303
- Always verify commands that interact with external systems
247304

248305
**Interface elements:**
249-
- Text field to enter command prefixes (e.g., 'git')
306+
- Text field to enter command prefixes
250307
- "Add" button to add new prefixes
251308
- Clickable command buttons with X to remove them
309+
310+
**Common whitelist examples:**
311+
- `git` - Version control operations
312+
- `npm run` - Run package.json scripts
313+
- `python -m pytest` - Run Python tests
314+
- `cargo test` - Run Rust tests
315+
- `go test` - Run Go tests
316+
- `docker ps` - List Docker containers
317+
- `ls` - List directory contents
318+
- `cat` - Display file contents
319+
320+
**Security tip:** Be specific with prefixes. Instead of allowing all `python` commands, limit to `python -m pytest` for test execution only.
252321
:::
253322

254323
### Follow-Up Questions
255324

256-
:::info Follow-Up Questions
325+
:::info Follow-Up Questions (Risk: Low)
257326
<img src="/img/auto-approving-actions/auto-approving-actions-15.png" alt="Follow-up question operations setting with timeout slider" width="550" />
258327

259328
**Setting:** `Always default answer for follow-up questions`
260329

261-
**Description:** Automatically selects the first AI-suggested answer for a follow-up question after a configurable timeout. This speeds up your workflow by letting Roo proceed without manual intervention. A visual countdown appears on the first suggestion.
330+
**Description:** Automatically selects the first AI-suggested answer for a follow-up question after a configurable timeout. This speeds up your workflow by letting Roo proceed without manual intervention.
331+
332+
**Visual countdown:** When enabled, a countdown timer appears on the first suggestion button, showing the remaining time before auto-selection. The timer is displayed as a circular progress indicator that depletes as time passes.
262333

263334
**Timeout slider:** Use the slider to set the wait time from 1 to 300 seconds (Default: 60s).
264335

265-
**Note:** You can override the timer at any point by clicking a different suggestion, editing a suggestion, or typing a response.
336+
**Override options:** You can cancel the auto-selection at any time by:
337+
- Clicking a different suggestion
338+
- Editing any suggestion
339+
- Typing your own response
340+
- Clicking the timer to pause it
266341

267342
**Risk level:** Low
343+
344+
**Use cases:**
345+
- Overnight runs where you want Roo to continue working
346+
- Repetitive tasks where the default suggestions are usually correct
347+
- Testing workflows where interaction isn't critical
348+
:::
349+
350+
### Update Todo List
351+
352+
:::info Update Todo List (Risk: Low)
353+
354+
**Setting:** "Always approve todo list updates"
355+
356+
**Description:** "Automatically update the to-do list without requiring approval"
357+
358+
**Risk level:** Low
359+
360+
This setting allows Roo to automatically update task progress and todo lists during work sessions. This includes:
361+
- Marking tasks as completed
362+
- Adding new discovered tasks
363+
- Updating task status (pending, in progress, completed)
364+
- Reorganizing task priorities
365+
366+
**Benefits:**
367+
- Maintains real-time task progress visibility
368+
- Reduces interruptions during multi-step workflows
369+
- Keeps project status accurately reflected
370+
- Helps track complex task dependencies
371+
372+
**Use cases:**
373+
- Long-running development sessions
374+
- Multi-step refactoring projects
375+
- Complex debugging workflows
376+
- Feature implementation with many subtasks
377+
378+
This is particularly useful when combined with the Subtasks permission, as it allows Roo to maintain a complete picture of project progress without constant approval requests.
268379
:::

0 commit comments

Comments
 (0)