Skip to content

Commit b199354

Browse files
committed
More fixes to the documentation
Signed-off-by: David Gageot <david.gageot@docker.com>
1 parent aedede9 commit b199354

5 files changed

Lines changed: 59 additions & 68 deletions

File tree

docs/pages/configuration/agents.html

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,12 @@ <h2>Full Schema</h2>
2727
name: "prompt text"
2828
welcome_message: string # Optional: message shown at session start
2929
handoffs: [list] # Optional: list of A2A handoff agents
30-
defer: [list] or true # Optional: tools to load on demand
3130
hooks: # Optional: lifecycle hooks
3231
pre_tool_use: [list]
3332
post_tool_use: [list]
3433
session_start: [list]
3534
session_end: [list]
3635
on_user_input: [list]
37-
permissions: # Optional: tool execution control
38-
allow: [list]
39-
deny: [list]
4036
structured_output: # Optional: constrain output format
4137
name: string
4238
schema: object</code></pre>
@@ -125,18 +121,10 @@ <h2>Properties Reference</h2>
125121
<td><code>handoffs</code></td><td>array</td><td></td>
126122
<td>List of A2A agent configurations this agent can delegate to. See <a href="#features/a2a" onclick="event.preventDefault(); navigate('features/a2a')">A2A Protocol</a>.</td>
127123
</tr>
128-
<tr>
129-
<td><code>defer</code></td><td>array/boolean</td><td></td>
130-
<td>Tools to load on-demand rather than at startup. Set to <code>true</code> to defer all tools, or provide a list of tool names.</td>
131-
</tr>
132124
<tr>
133125
<td><code>hooks</code></td><td>object</td><td></td>
134126
<td>Lifecycle hooks for running commands at various points. See <a href="#configuration/hooks" onclick="event.preventDefault(); navigate('configuration/hooks')">Hooks</a>.</td>
135127
</tr>
136-
<tr>
137-
<td><code>permissions</code></td><td>object</td><td></td>
138-
<td>Control which tools are auto-approved, require confirmation, or are blocked. See <a href="#configuration/permissions" onclick="event.preventDefault(); navigate('configuration/permissions')">Permissions</a>.</td>
139-
</tr>
140128
<tr>
141129
<td><code>structured_output</code></td><td>object</td><td></td>
142130
<td>Constrain agent output to match a JSON schema. See <a href="#configuration/structured-output" onclick="event.preventDefault(); navigate('configuration/structured-output')">Structured Output</a>.</td>
@@ -180,20 +168,23 @@ <h2>Deferred Tool Loading</h2>
180168
toolsets:
181169
- type: mcp
182170
ref: docker:github-official
171+
defer: true
183172
- type: mcp
184173
ref: docker:slack
185-
- type: filesystem
186-
# Defer all tools - load when first used
187-
defer: true</code></pre>
174+
defer: true
175+
- type: filesystem</code></pre>
188176

189-
<p>Or defer specific tools:</p>
177+
<p>Or defer specific tools within a toolset:</p>
190178

191179
<pre><code class="language-yaml">agents:
192180
root:
193181
model: openai/gpt-4o
194-
defer:
195-
- "mcp:github:*" # Defer all GitHub tools
196-
- "mcp:slack:*" # Defer all Slack tools</code></pre>
182+
toolsets:
183+
- type: mcp
184+
ref: docker:github-official
185+
defer:
186+
- "list_issues"
187+
- "search_repos"</code></pre>
197188

198189
<h2>Fallback Configuration</h2>
199190

@@ -280,25 +271,15 @@ <h2>Complete Example</h2>
280271
description: Expert software developer
281272
instruction: Write clean, tested, production-ready code.
282273
max_iterations: 30
283-
toolsets:
284-
- type: filesystem
285-
- type: shell
286-
- type: think
287-
- type: todo
288-
permissions:
289-
allow:
290-
- "read_*"
291-
- "shell:cmd=go*"
292-
- "shell:cmd=npm*"
293-
deny:
294-
- "shell:cmd=sudo*"
295274
toolsets:
296275
- type: filesystem
297276
- type: shell
298277
sandbox:
299278
image: golang:1.23-alpine
300279
paths:
301280
- "."
281+
- type: think
282+
- type: todo
302283

303284
researcher:
304285
model: openai/gpt-4o

docs/pages/configuration/overview.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h2>Config Sections</h2>
8383
<a class="card" href="#configuration/agents" onclick="event.preventDefault(); navigate('configuration/agents')">
8484
<div class="card-icon">🤖</div>
8585
<h3>Agent Config</h3>
86-
<p>All agent properties: model, instruction, tools, sub-agents, permissions, hooks, and more.</p>
86+
<p>All agent properties: model, instruction, tools, sub-agents, hooks, and more.</p>
8787
</a>
8888
<a class="card" href="#configuration/models" onclick="event.preventDefault(); navigate('configuration/models')">
8989
<div class="card-icon">🧠</div>

docs/pages/configuration/permissions.html

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,19 @@ <h2>Configuration</h2>
1717
model: openai/gpt-4o
1818
description: Agent with permission controls
1919
instruction: You are a helpful assistant.
20-
permissions:
21-
# Auto-approve these tools (no confirmation needed)
22-
allow:
23-
- "read_file"
24-
- "read_*" # Glob patterns
25-
- "shell:cmd=ls*" # With argument matching
26-
27-
# Block these tools entirely
28-
deny:
29-
- "shell:cmd=sudo*"
30-
- "shell:cmd=rm*-rf*"
31-
- "dangerous_tool"</code></pre>
20+
21+
permissions:
22+
# Auto-approve these tools (no confirmation needed)
23+
allow:
24+
- "read_file"
25+
- "read_*" # Glob patterns
26+
- "shell:cmd=ls*" # With argument matching
27+
28+
# Block these tools entirely
29+
deny:
30+
- "shell:cmd=sudo*"
31+
- "shell:cmd=rm*-rf*"
32+
- "dangerous_tool"</code></pre>
3233

3334
<h2>Pattern Syntax</h2>
3435

docs/pages/configuration/sandbox.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,12 +141,13 @@ <h2>Combining with Permissions</h2>
141141
paths:
142142
- ".:rw"
143143
- type: filesystem
144-
permissions:
145-
allow:
146-
- "shell:cmd=npm*"
147-
- "shell:cmd=node*"
148-
- "shell:cmd=ls*"
149-
deny:
150-
- "shell:cmd=sudo*"
151-
- "shell:cmd=curl*"
152-
- "shell:cmd=wget*"</code></pre>
144+
145+
permissions:
146+
allow:
147+
- "shell:cmd=npm*"
148+
- "shell:cmd=node*"
149+
- "shell:cmd=ls*"
150+
deny:
151+
- "shell:cmd=sudo*"
152+
- "shell:cmd=curl*"
153+
- "shell:cmd=wget*"</code></pre>

docs/pages/guides/tips.html

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,26 @@ <h3>Defer Tools for Faster Startup</h3>
6565
toolsets:
6666
- type: mcp
6767
ref: docker:github-official
68+
defer: true
6869
- type: mcp
6970
ref: docker:slack
71+
defer: true
7072
- type: mcp
7173
ref: docker:linear
72-
# Load all tools on first use
73-
defer: true</code></pre>
74+
defer: true</code></pre>
7475

75-
<p>Or defer specific tools:</p>
76+
<p>Or defer specific tools within a toolset:</p>
7677

77-
<pre><code class="language-yaml">defer:
78-
- "mcp:github:*" # Defer GitHub tools
79-
- "mcp:slack:*" # Defer Slack tools</code></pre>
78+
<pre><code class="language-yaml">toolsets:
79+
- type: mcp
80+
ref: docker:github-official
81+
defer:
82+
- "list_issues"
83+
- "search_repos"
84+
- type: mcp
85+
ref: docker:slack
86+
defer:
87+
- "list_channels"</code></pre>
8088

8189
<h3>Filter MCP Tools</h3>
8290

@@ -185,15 +193,15 @@ <h3>Combine Permissions with Sandbox</h3>
185193
image: golang:1.23-alpine
186194
paths:
187195
- ".:rw"
188-
# Permission controls
189-
permissions:
190-
allow:
191-
- "read_*"
192-
- "shell:cmd=go*"
193-
- "shell:cmd=npm*"
194-
deny:
195-
- "shell:cmd=sudo*"
196-
- "shell:cmd=rm*-rf*"</code></pre>
196+
197+
permissions:
198+
allow:
199+
- "read_*"
200+
- "shell:cmd=go*"
201+
- "shell:cmd=npm*"
202+
deny:
203+
- "shell:cmd=sudo*"
204+
- "shell:cmd=rm*-rf*"</code></pre>
197205

198206
<h3>Use Hooks for Audit Logging</h3>
199207

0 commit comments

Comments
 (0)