WebAccessInfo

Defined in: packages/tools/src/web/provider.ts:24

The describeWebEnv tool’s payload — see createWebToolProvider.

Properties

allowedDomains?

optional allowedDomains?: readonly string[]

Defined in: packages/tools/src/web/provider.ts:38

Hostname allowlist this call’s fetchUrl enforces. Omitted when there is no allowlist (any host, still subject to deniedDomains and the address checks).

---

allowedSchemes

allowedSchemes: readonly string[]

Defined in: packages/tools/src/web/provider.ts:26

URL schemes this call’s fetchUrl will fetch.

---

allowedUrls

allowedUrls: readonly string[]

Defined in: packages/tools/src/web/provider.ts:33

The URL patterns exempt from the address check for this call. Empty when nothing is exempt. Reported as display strings (String(pattern)) rather than raw UrlPattern values — a RegExp serializes to "{}" under JSON.stringify, silently losing the pattern once an AI SDK turn serializes the tool result.

---

allowPrivateNetwork

allowPrivateNetwork: boolean

Defined in: packages/tools/src/web/provider.ts:43

true when this call’s fetchUrl has the address check disabled entirely — see AddressPolicy.allowPrivateNetwork. Its own field, not folded into allowedUrls.

---

deniedDomains?

optional deniedDomains?: readonly string[]

Defined in: packages/tools/src/web/provider.ts:40

Hostname denylist this call’s fetchUrl enforces. Omitted when empty.

---

maxRedirects

maxRedirects: number

Defined in: packages/tools/src/web/provider.ts:49

Redirect hops this call’s fetchUrl will follow before refusing.

---

maxResponseBytes

maxResponseBytes: number

Defined in: packages/tools/src/web/provider.ts:47

The response byte cap this call’s fetchUrl actually enforces.

---

timeoutMs

timeoutMs: number

Defined in: packages/tools/src/web/provider.ts:45

The wall-clock timeout (ms) this call’s fetchUrl actually enforces.