> ## Documentation Index
> Fetch the complete documentation index at: https://openrouter.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# WebSearchServerTool - TypeScript SDK

> WebSearchServerTool type definition

<Warning>
  The TypeScript SDK and docs are currently in beta.
  Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues).
</Warning>

Web search tool configuration (2025-08-26 version)

## Example Usage

```typescript lines theme={null}
import { WebSearchServerTool } from "@openrouter/sdk/models";

let value: WebSearchServerTool = {
  type: "web_search_2025_08_26",
};
```

## Fields

| Field               | Type                                                                                             | Required             | Description                                                                                                                                                                                                                                                                | Example                                                                                                                     |
| ------------------- | ------------------------------------------------------------------------------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `engine`            | [models.WebSearchEngineEnum](/agent-sdk/typescript/api-reference/models/websearchengineenum)     | :heavy\_minus\_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. | auto                                                                                                                        |
| `filters`           | [models.WebSearchDomainFilter](/agent-sdk/typescript/api-reference/models/websearchdomainfilter) | :heavy\_minus\_sign: | N/A                                                                                                                                                                                                                                                                        | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}`                                                     |
| `maxResults`        | *number*                                                                                         | :heavy\_minus\_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.                                                                                                           | 5                                                                                                                           |
| `searchContextSize` | [models.SearchContextSizeEnum](/agent-sdk/typescript/api-reference/models/searchcontextsizeenum) | :heavy\_minus\_sign: | Size of the search context for web search tools                                                                                                                                                                                                                            | medium                                                                                                                      |
| `type`              | *"web\_search\_2025\_08\_26"*                                                                    | :heavy\_check\_mark: | N/A                                                                                                                                                                                                                                                                        |                                                                                                                             |
| `userLocation`      | [models.WebSearchUserLocation](/agent-sdk/typescript/api-reference/models/websearchuserlocation) | :heavy\_minus\_sign: | User location information for web search                                                                                                                                                                                                                                   | `{"city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles","type": "approximate"}` |