FetchUrlToolOptions
Defined in: packages/tools/src/web/tools.ts:42
Shared constructor fields for tools that materialize through an EffectGate.
Extends
Section titled “Extends”Properties
Section titled “Properties”allowedDomains?
Section titled “allowedDomains?”
optionalallowedDomains?: readonlystring[]
Defined in: packages/tools/src/web/tools.ts:52
Hostname allowlist — see AddressPolicy.allowedDomains. Omitted means no
allowlist. Empty denies every host. "*" allows any host.
allowedUrls?
Section titled “allowedUrls?”
optionalallowedUrls?: readonlyUrlPattern[]
Defined in: packages/tools/src/web/tools.ts:47
URL patterns (glob strings and/or RegExps) allowed past the address check — see
AddressPolicy.allowedUrls. Empty by default.
allowPrivateNetwork?
Section titled “allowPrivateNetwork?”
optionalallowPrivateNetwork?:boolean
Defined in: packages/tools/src/web/tools.ts:61
Disables the address check entirely — see AddressPolicy.allowPrivateNetwork. Default
false. Never reachable from the model; discoverable via describeWebEnv.
deniedDomains?
Section titled “deniedDomains?”
optionaldeniedDomains?: readonlystring[]
Defined in: packages/tools/src/web/tools.ts:56
Hostname denylist — see AddressPolicy.deniedDomains.
effectGate
Section titled “effectGate”effectGate:
EffectGate
Defined in: packages/tools/src/approval/types.ts:25
Pre-materialize gate. Required — pass import(“@agent-dev-lab/core”).allowAllGate explicitly for tests / permissive local hosts.
Inherited from
Section titled “Inherited from”effectScope
Section titled “effectScope”effectScope:
ToolEffectScope
Defined in: packages/tools/src/approval/types.ts:27
Run identity stamped onto each tool intent.
Inherited from
Section titled “Inherited from”maxRedirects?
Section titled “maxRedirects?”
optionalmaxRedirects?:number
Defined in: packages/tools/src/web/tools.ts:69
Redirect hops to follow before refusing. Default 20.
maxResponseBytes?
Section titled “maxResponseBytes?”
optionalmaxResponseBytes?:number
Defined in: packages/tools/src/web/tools.ts:67
Stop reading a response body at this many bytes. Default 1,000,000 (1 MB).
resolver?
Section titled “resolver?”
optionalresolver?:HostnameResolver
Defined in: packages/tools/src/web/tools.ts:63
Hostname resolver override. Defaults to node:dns; exists so the policy can be tested.
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Defined in: packages/tools/src/web/tools.ts:65
Wall-clock timeout for the whole fetch, in milliseconds. Default 30,000 (30s).