Skip to content

Commit 93eeec7

Browse files
committed
docs: Update prompt structure and experimental features documentation; add tool messages and remove outdated features
1 parent 0ad00df commit 93eeec7

File tree

3 files changed

+25
-17
lines changed

3 files changed

+25
-17
lines changed

docs/advanced-usage/prompt-structure.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Roo Code uses three primary message types when communicating with LLMs:
1010
- **User Messages**: Content sent by you (the user) to Roo
1111
- **Assistant Messages**: Responses generated by the LLM based on your requests
1212

13+
At the API level, there's also a fourth message role:
14+
15+
- **Tool Messages**: Results returned from tool executions, sent back to the LLM as input
16+
1317
Understanding these message types helps you work more effectively with Roo and can be valuable for troubleshooting or advanced customization.
1418

1519
## System Prompt
@@ -42,7 +46,8 @@ User messages contain your direct inputs to Roo, plus additional contextual info
4246
- Cursor position
4347
- Active terminals with output
4448
- Recently modified files
45-
- Current time and token/cost information
49+
- Current time
50+
- Token/cost information
4651
- Current mode
4752
- File listing (on initial connection)
4853

@@ -55,7 +60,8 @@ Assistant messages are the LLM's responses, which may include:
5560
- **Text Responses**: Direct answers to your queries
5661
- **Thinking**: Internal reasoning process (visible when enabled)
5762
- **Tool Calls**: Requests to use specific tools like reading files or executing commands
58-
- **Tool Results**: The outcome of executed tools
63+
64+
Note that while assistant messages contain tool calls, the results of those tools are sent back to the LLM in separate tool messages, not as part of the assistant message itself.
5965

6066
## Message Flow
6167

@@ -77,6 +83,17 @@ Internally, Roo's prompt construction is handled by several components:
7783
- **Message Transformation**: Provider-specific transformers convert Roo's internal message format to the format required by each LLM API
7884
- **Custom Prompt Loading**: The `loadSystemPromptFile` function checks for and processes custom system prompt files
7985

86+
## Support Prompts
87+
88+
Alongside the main chat flow, Roo uses specialized templates for specific code actions:
89+
90+
- **Code Action Prompts**: For commands like "Explain", "Fix", "Improve", or "Add to Context"
91+
- **Template-Based**: Generated from templates in `src/shared/support-prompt.ts`
92+
- **Independent Context**: Often operates without the main chat history
93+
- **Task-Specific Format**: Optimized for the specific code task being performed
94+
95+
These support prompts work outside the normal conversation flow to provide focused assistance for specific coding tasks.
96+
8097
## Optimizing Your Interactions
8198

8299
Understanding this structure can help you:

docs/features/experimental/experimental-features.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,6 @@ To enable or disable experimental features:
1818

1919
The following experimental features are currently available:
2020

21-
### Search and Replace
22-
23-
Adds a new tool for searching and replacing text in a file.
24-
25-
### Insert Content
26-
27-
Adds a new tool for inserting content at any position in a file.
28-
2921
### Power Steering
3022

3123
When enabled, Roo will remind the model about the details of its current mode definition more frequently. This will lead to stronger adherence to role definitions and custom instructions, but will use more tokens per message.

sidebars.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ const sidebars: SidebarsConfig = {
3636
'features/keyboard-shortcuts',
3737
'features/model-temperature',
3838
'features/settings-management',
39-
'features/suggested-responses',
4039
'features/shell-integration',
40+
'features/suggested-responses',
4141
{
4242
type: 'category',
4343
label: 'MCP',
@@ -67,11 +67,6 @@ const sidebars: SidebarsConfig = {
6767
type: 'category',
6868
label: 'Advanced Usage',
6969
items: [
70-
'advanced-usage/prompt-engineering',
71-
'advanced-usage/prompt-structure',
72-
'advanced-usage/large-projects',
73-
'advanced-usage/rate-limits-costs',
74-
'advanced-usage/local-models',
7570
{
7671
type: 'category',
7772
label: 'Available Tools',
@@ -88,13 +83,17 @@ const sidebars: SidebarsConfig = {
8883
'advanced-usage/available-tools/list-files',
8984
'advanced-usage/available-tools/new-task',
9085
'advanced-usage/available-tools/read-file',
91-
'advanced-usage/available-tools/search-and-replace',
9286
'advanced-usage/available-tools/search-files',
9387
'advanced-usage/available-tools/switch-mode',
9488
'advanced-usage/available-tools/use-mcp-tool',
9589
'advanced-usage/available-tools/write-to-file',
9690
],
9791
},
92+
'advanced-usage/prompt-engineering',
93+
'advanced-usage/prompt-structure',
94+
'advanced-usage/rate-limits-costs',
95+
'advanced-usage/local-models',
96+
'advanced-usage/large-projects',
9897
],
9998
},
10099
{

0 commit comments

Comments
 (0)