You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/agent-format.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,9 @@
2
2
3
3
The agent configuration file for each agent is a JSON file. The filename (without the `.json` extension) becomes the agent's name. It contains configuration needed to instantiate and run the agent.
4
4
5
+
> [!TIP]
6
+
> We recommend using the `/agent generate` slash command within your active Q session to intelligently generate your agent configuration with the help of Q.
7
+
5
8
Every agent configuration file can include the following sections:
6
9
7
10
-[`name`](#name-field) — The name of the agent (optional, derived from filename if not specified).
@@ -15,6 +18,7 @@ Every agent configuration file can include the following sections:
15
18
-[`resources`](#resources-field) — Resources available to the agent.
16
19
-[`hooks`](#hooks-field) — Commands run at specific trigger points.
17
20
-[`useLegacyMcpJson`](#uselegacymcpjson-field) — Whether to include legacy MCP configuration.
21
+
-[`model`](#model-field) — The model ID to use for this agent.
18
22
19
23
## Name Field
20
24
@@ -290,6 +294,20 @@ The `useLegacyMcpJson` field determines whether to include MCP servers defined i
290
294
291
295
When set to `true`, the agent will have access to all MCP servers defined in the global and local configurations in addition to those defined in the agent's `mcpServers` field.
292
296
297
+
## Model Field
298
+
299
+
The `model` field specifies the model ID to use for this agent. If not specified, the agent will use the default model.
300
+
301
+
```json
302
+
{
303
+
"model": "claude-sonnet-4"
304
+
}
305
+
```
306
+
307
+
The model ID must match one of the available models returned by the Q CLI's model service. You can see available models by using the `/model` command in an active chat session.
308
+
309
+
If the specified model is not available, the agent will fall back to the default model and display a warning.
310
+
293
311
## Complete Example
294
312
295
313
Here's a complete example of an agent configuration file:
@@ -348,6 +366,7 @@ Here's a complete example of an agent configuration file:
Copy file name to clipboardExpand all lines: docs/knowledge-management.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
3
3
The /knowledge command provides persistent knowledge base functionality for Amazon Q CLI, allowing you to store, search, and manage contextual information that persists across chat sessions.
4
4
5
-
> Note: This is a beta feature that must be enabled before use.
5
+
> [!NOTE]
6
+
> This is a beta feature that must be enabled before use.
Copy file name to clipboardExpand all lines: schemas/agent-v1.json
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -159,6 +159,14 @@
159
159
"description": "Whether or not to include the legacy ~/.aws/amazonq/mcp.json in the agent\nYou can reference tools brought in by these servers as just as you would with the servers\nyou configure in the mcpServers field in this config",
160
160
"type": "boolean",
161
161
"default": false
162
+
},
163
+
"model": {
164
+
"description": "The model ID to use for this agent. If not specified, uses the default model.",
0 commit comments