Skip to content

Commit 0ead0be

Browse files
committed
docs: clarify tool approval guidance
1 parent c2905c3 commit 0ead0be

32 files changed

Lines changed: 65 additions & 95 deletions

File tree

.changeset/voltagent-3-next.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,7 @@ const refundCustomer = tool({
181181
},
182182
voltagent: {
183183
name: "refundCustomer",
184-
purpose: "Issue customer refunds after approval",
185-
needsApproval: true,
184+
purpose: "Issue customer refunds",
186185
},
187186
});
188187
```
@@ -202,7 +201,7 @@ const result = await agent.streamText({
202201
});
203202
```
204203

205-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
204+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
206205

207206
### Structured output
208207

packages/a2a-server/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/ag-ui/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/cli/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/cloudflare-d1/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/core/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/create-voltagent-app/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/docs-mcp/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/evals/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

packages/internal/CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@
155155
},
156156
voltagent: {
157157
name: "refundCustomer",
158-
purpose: "Issue customer refunds after approval",
159-
needsApproval: true,
158+
purpose: "Issue customer refunds",
160159
},
161160
});
162161
```
@@ -176,7 +175,7 @@
176175
});
177176
```
178177

179-
Tools configured with VoltAgent `needsApproval` continue to participate in VoltAgent approval-aware flows. Native visible tools can use AI SDK approval responses, while hidden routed tools still enforce VoltAgent routing policy before execution.
178+
Use call-level `toolApproval` for new per-request approval flows. Use `voltagent.needsApproval` only when approval should be static tool metadata or part of an existing VoltAgent approval/tool-policy flow. If both are provided, call-level `toolApproval` takes precedence.
180179

181180
### Structured output
182181

0 commit comments

Comments
 (0)