Web search

webSearch() gives an Agent access to web context through an explicit mode. Use model mode for provider-native web search, or tool mode for normalized web_search and web_read tools.

Installation

Import the Capability factory from -hub/agent/capabilities and add it to defineAgent({ capabilities }). Use the configuration example below as the starting point, then tighten modes, policies, stores, and providers for the Agent boundary.

What it adds

Model mode contributes a provider tool request for web_search. Tool mode contributes web_search and web_read model-facing tools backed by a single configured search provider.

Configuration

Use model mode when the selected model provider supports provider-native web search. Tool mode requires a web search provider configuration.

import { defineAgent } from '@vite-hub/agent'
import { webSearch } from '@vite-hub/agent/capabilities'

export default defineAgent({
  driver: { model },
  capabilities: [
    webSearch({ mode: 'model' }),
  ],
})

Runtime behavior

Model mode adds a Provider Tool contribution and leaves search execution to the model provider. Tool mode loads the configured provider, executes normalized search requests, and reads URLs as Markdown or text.

Requirements

webSearch() requires mode: 'model' or mode: 'tool'. Model mode requires an Agent Driver and model provider that support the provider tool.

Tool mode requires the application to install askweb and configure one web search provider with any required credentials.

Driver support

Inspect and verify

Inspect provider tool contributions for model mode or the Agent tool list for tool mode. Tool mode should expose web_search and web_read.

Run tool mode without askweb during development. The Capability should report the missing package and suggest model mode as the alternative.

Options

Reference

• Official capabilities
• fetch()
• Source: packages/agent/src/capabilities/web-search/index.ts