Skip to content

Commit 6852e50

Browse files
author
Your Name
committed
Update documentation
1 parent 30ca34f commit 6852e50

2 files changed

Lines changed: 34 additions & 12 deletions

File tree

cecli/website/docs/config/agent-mode.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Agent Mode uses a centralized local tool registry that manages all available too
5252
- **Git Tools**: `GitDiff`, `GitLog`, `GitShow`, `GitStatus`
5353
- **Utility Tools**: `UpdateTodoList`, `UndoChange`, `Finished`
5454
- **Skill Management**: `LoadSkill`, `RemoveSkill`
55+
- **Sub-Agent Tools**: `Delegate` - Delegate sub-tasks to specialized sub-agents
5556

5657
#### Enhanced Context Management
5758

@@ -154,6 +155,14 @@ agent-config:
154155
tools_excludelist: ["command", "commandinteractive"] # Optional: Blacklist of tools
155156
tools_paths: ["./custom-tools", "~/my-tools"] # Optional: Directories or files containing custom tools
156157

158+
# Server configuration
159+
servers_includelist: ["local"] # Optional: Whitelist of MCP server names to allow
160+
servers_excludelist: [] # Optional: Blacklist of MCP server names to exclude
161+
162+
# Sub-agent configuration
163+
subagent_paths: [".cecli/subagents"] # Optional: Directories to search for sub-agent definitions
164+
max_sub_agents: 3 # Optional: Maximum concurrent sub-agents (default: 3)
165+
157166
# Context blocks configuration
158167
include_context_blocks: ["todo_list", "git_status"] # Optional: Context blocks to include
159168
exclude_context_blocks: ["symbol_outline", "directory_structure"] # Optional: Context blocks to exclude
@@ -177,6 +186,10 @@ agent-config:
177186
- **`tools_includelist`**: Array of tool names to allow (only these tools will be available)
178187
- **`tools_excludelist`**: Array of tool names to exclude (these tools will be disabled)
179188
- **`tools_paths`**: Array of directories or Python files containing custom tools to load
189+
- **`servers_includelist`**: Array of MCP server names to allow (only these servers will be available)
190+
- **`servers_excludelist`**: Array of MCP server names to exclude (these servers will be disabled)
191+
- **`subagent_paths`**: Array of directories to search for sub-agent definition `.md` files
192+
- **`max_sub_agents`**: Maximum number of concurrent sub-agents (default: 3)
180193
- **`include_context_blocks`**: Array of context block names to include (overrides default set)
181194
- **`exclude_context_blocks`**: Array of context block names to exclude from default set
182195

@@ -256,6 +269,7 @@ The following context blocks are available by default and can be customized usin
256269
- **`symbol_outline`**: Lists classes, functions, and methods in current context
257270
- **`todo_list`**: Shows the current todo list managed via `UpdateTodoList` tool
258271
- **`skills`**: Include skills content in the conversation
272+
- **`sub_agents`**: Include registered sub-agents in the conversation context
259273

260274
When `include_context_blocks` is specified, only the listed blocks will be included. When `exclude_context_blocks` is specified, the listed blocks will be removed from the default set.
261275

@@ -282,6 +296,14 @@ agent-config:
282296
tools_excludelist: ["command", "commandinteractive"] # Optional: Blacklist of tools
283297
tools_paths: ["./custom-tools", "~/my-tools"] # Optional: Directories or files containing custom tools
284298
299+
# Server configuration
300+
servers_includelist: ["local"] # Optional: Whitelist of MCP server names to allow
301+
servers_excludelist: [] # Optional: Blacklist of MCP server names to exclude
302+
303+
# Sub-agent configuration
304+
subagent_paths: [".cecli/subagents"] # Optional: Directories to search for sub-agent definitions
305+
max_sub_agents: 3 # Optional: Maximum concurrent sub-agents (default: 3)
306+
285307
# Context blocks configuration
286308
include_context_blocks: ["todo_list", "git_status"] # Optional: Context blocks to include
287309
exclude_context_blocks: ["symbol_outline", "directory_structure"] # Optional: Context blocks to exclude

cecli/website/docs/config/subagents.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Sub-agents can be used for:
2121
┌─────────────────────────────────────────────────────────┐
2222
│ TUI Session │
2323
│ ┌──────────────────────────────────────────────────┐ │
24-
│ │ SubAgentPills: ○ Primary ● reviewer ○ tester │ │
24+
│ │ Mode: ○ primary ◆ reviewer ○ tester │ │
2525
│ ├──────────────────────────────────────────────────┤ │
2626
│ │ OutputContainer (active agent) │ │
2727
│ ├──────────────────────────────────────────────────┤ │
@@ -67,7 +67,7 @@ and suggestions for improvement.
6767

6868
| Field | Required | Description |
6969
|-------|----------|-------------|
70-
| `name` | Yes | Unique name used to reference the sub-agent in commands and the Dispatch tool |
70+
| `name` | Yes | Unique name used to reference the sub-agent in commands and the Delegate tool |
7171
| `model` | No | Model override for this sub-agent. If omitted, inherits the parent agent's model |
7272

7373
#### System Prompt
@@ -107,13 +107,13 @@ The most common way to use sub-agents. The primary agent waits for the sub-agent
107107

108108
This sends the prompt to the reviewer sub-agent, which works autonomously and returns a summary when done.
109109

110-
### Dispatching from the Primary Agent
110+
### Delegating from the Primary Agent
111111

112-
The primary agent can also delegate work using the `Dispatch` tool. This enables the autonomous workflow:
112+
The primary agent can also delegate work using the `Delegate` tool. This enables the autonomous workflow:
113113

114114
1. The primary agent analyzes a task
115115
2. It decomposes the work into sub-tasks
116-
3. It dispatches each sub-task to the appropriate sub-agent
116+
3. It delegates each sub-task to the appropriate sub-agent
117117
4. Sub-agents work independently and return their summaries
118118
5. The primary agent synthesizes the results
119119

@@ -141,10 +141,10 @@ This is useful if a sub-agent is stuck, misbehaving, or you no longer need its w
141141

142142
### Switching Between Agents
143143

144-
When sub-agents are active, the TUI shows a **SubAgentPills** bar at the top of the output area, displaying each agent as a clickable pill:
144+
When sub-agents are active, the TUI shows agent pills in the input container's border title, displaying each agent with status icons:
145145

146146
```
147-
┌─ [primary] ● [reviewer][tester] ──────────────────┐
147+
┌─ agent: ○ primaryreviewer ○ tester ─────────────────┐
148148
```
149149

150150
- **Keyboard**: Use `Ctrl+Alt+Left` / `Ctrl+Alt+Right` to cycle through agents. Use `Ctrl+Alt+Up` to return to the primary agent.
@@ -157,13 +157,13 @@ Each agent gets its own output container. When you switch agents:
157157
1. The active container is shown; all others are hidden
158158
2. Your input is routed to the active agent
159159
3. Tool output, streaming responses, and task notifications are displayed in the correct container
160-
4. The SubAgentPills bar highlights the active agent
160+
4. Agent pills in the border title highlight the active agent
161161

162162
## Lifecycle and Limits
163163

164164
### Max Sub-Agents
165165

166-
The `max_subagents` setting (default: 3) limits how many concurrent sub-agents can exist. This prevents resource exhaustion.
166+
The `max_sub_agents` setting (default: 3) limits how many concurrent sub-agents can exist. This prevents resource exhaustion.
167167

168168
When the limit is reached:
169169

@@ -178,7 +178,7 @@ When the limit is reached:
178178

179179
## Restrictions
180180

181-
- **No nested sub-agents**: Sub-agents cannot spawn further sub-agents. The `Dispatch` tool is excluded from sub-agent tool schemas.
181+
- **No nested sub-agents**: Sub-agents cannot spawn further sub-agents. The `Delegate` tool is excluded from sub-agent tool schemas.
182182
- **TUI-dependent**: Sub-agent container switching and the reap command depend on the TUI. Running in headless or non-TUI modes may not support these features.
183183

184184
## Examples
@@ -222,8 +222,8 @@ happy paths. Use the project's existing testing patterns and conventions.
222222

223223
By defining multiple sub-agents, you can get different perspectives on the same code:
224224

225-
1. Dispatch a **reviewer** to analyze security concerns
226-
2. Dispatch a **tester** to identify test gaps
225+
1. Delegate to a **reviewer** to analyze security concerns
226+
2. Delegate to a **tester** to identify test gaps
227227
3. The primary agent synthesizes both reports into an action plan
228228

229229
## See Also

0 commit comments

Comments
 (0)