Skip to content

Commit c0242b4

Browse files
committed
docs(hooks): document ask decision for BeforeTool
1 parent c22137e commit c0242b4

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/hooks/reference.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ All hooks receive these common fields via `stdin`:
6363

6464
Most hooks support these fields in their `stdout` JSON:
6565

66-
| Field | Type | Description |
67-
| :--------------- | :-------- | :----------------------------------------------------------------------------- |
68-
| `systemMessage` | `string` | Displayed immediately to the user in the terminal. |
69-
| `suppressOutput` | `boolean` | If `true`, hides internal hook metadata from logs/telemetry. |
70-
| `continue` | `boolean` | If `false`, stops the entire agent loop immediately. |
71-
| `stopReason` | `string` | Displayed to the user when `continue` is `false`. |
72-
| `decision` | `string` | `"allow"` or `"deny"` (alias `"block"`). Specific impact depends on the event. |
73-
| `reason` | `string` | The feedback/error message provided when a `decision` is `"deny"`. |
66+
| Field | Type | Description |
67+
| :--------------- | :-------- | :-------------------------------------------------------------------------------------------------------- |
68+
| `systemMessage` | `string` | Displayed immediately to the user in the terminal. |
69+
| `suppressOutput` | `boolean` | If `true`, hides internal hook metadata from logs/telemetry. |
70+
| `continue` | `boolean` | If `false`, stops the entire agent loop immediately. |
71+
| `stopReason` | `string` | Displayed to the user when `continue` is `false`. |
72+
| `decision` | `string` | `"allow"`, `"deny"` (alias `"block"`), or `"ask"` for `BeforeTool`. Specific impact depends on the event. |
73+
| `reason` | `string` | The feedback/error message provided when a `decision` is `"deny"`. |
7474

7575
---
7676

@@ -101,8 +101,8 @@ and parameter rewriting.
101101
- `original_request_name`: (`string`) The original name of the tool being
102102
called, if this is a tail tool call.
103103
- **Relevant Output Fields**:
104-
- `decision`: Set to `"deny"` (or `"block"`) to prevent the tool from
105-
executing.
104+
- `decision`: Set to `"ask"` to force the normal user confirmation flow before
105+
the tool executes, or `"deny"` (or `"block"`) to prevent execution.
106106
- `reason`: Required if denied. This text is sent **to the agent** as a tool
107107
error, allowing it to respond or retry.
108108
- `hookSpecificOutput.tool_input`: An object that **merges with and

0 commit comments

Comments
 (0)