@deskcreate/agentcraft
Preparing search index...
adapters
ToolPolicy
Interface ToolPolicy
interface
ToolPolicy
{
allowSideEffects
?:
boolean
;
approvedTools
?:
string
[]
;
dryRun
?:
boolean
;
guardrailMode
?:
"enforce"
|
"warn"
;
inputGuardrails
?:
ToolGuardrail
[]
;
maxResultBytes
?:
number
;
onApprovalRequired
?:
(
context
:
ToolGuardrailContext
,
)
=>
boolean
|
Promise
<
boolean
>
;
onAuditEvent
?:
(
event
:
ToolAuditEvent
)
=>
void
|
Promise
<
void
>
;
outputGuardrails
?:
ToolGuardrail
[]
;
readOnly
?:
boolean
;
redactSecrets
?:
boolean
;
retry
?:
{
attempts
:
number
;
delayMs
?:
number
}
;
secretPatterns
?:
RegExp
[]
;
timeoutMs
?:
number
;
}
Index
Properties
allow
Side
Effects?
approved
Tools?
dry
Run?
guardrail
Mode?
input
Guardrails?
max
Result
Bytes?
on
Approval
Required?
on
Audit
Event?
output
Guardrails?
read
Only?
redact
Secrets?
retry?
secret
Patterns?
timeout
Ms?
Properties
Optional
allow
Side
Effects
allowSideEffects
?:
boolean
Optional
approved
Tools
approvedTools
?:
string
[]
Optional
dry
Run
dryRun
?:
boolean
Optional
guardrail
Mode
guardrailMode
?:
"enforce"
|
"warn"
Optional
input
Guardrails
inputGuardrails
?:
ToolGuardrail
[]
Optional
max
Result
Bytes
maxResultBytes
?:
number
Optional
on
Approval
Required
onApprovalRequired
?:
(
context
:
ToolGuardrailContext
,
)
=>
boolean
|
Promise
<
boolean
>
Optional
on
Audit
Event
onAuditEvent
?:
(
event
:
ToolAuditEvent
)
=>
void
|
Promise
<
void
>
Optional
output
Guardrails
outputGuardrails
?:
ToolGuardrail
[]
Optional
read
Only
readOnly
?:
boolean
Optional
redact
Secrets
redactSecrets
?:
boolean
Optional
retry
retry
?:
{
attempts
:
number
;
delayMs
?:
number
}
Optional
secret
Patterns
secretPatterns
?:
RegExp
[]
Optional
timeout
Ms
timeoutMs
?:
number
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
allow
Side
Effects
approved
Tools
dry
Run
guardrail
Mode
input
Guardrails
max
Result
Bytes
on
Approval
Required
on
Audit
Event
output
Guardrails
read
Only
redact
Secrets
retry
secret
Patterns
timeout
Ms
@deskcreate/agentcraft
Loading...