Struct WebSearchTool 

pub struct WebSearchTool {
    pub tool_type: String,
    pub name: String,
    pub allowed_domains: Option<Vec<String>>,
    pub blocked_domains: Option<Vec<String>>,
    pub max_uses: Option<u32>,
    pub user_location: Option<UserLocation>,
    pub cache_control: Option<CacheControl>,
}

Web search tool — lets Claude search the internet during a response.

Example

use claude_sdk::server_tools::WebSearchTool;

let tool = WebSearchTool::new()
    .with_allowed_domains(vec!["example.com".into()])
    .with_max_uses(5);

Fields

tool_type: String

Always "web_search_20260209" (or overridden via constructor)

name: String

Tool name (always "web_search")

allowed_domains: Option<Vec<String>>

Restrict searches to these domains only

blocked_domains: Option<Vec<String>>

Never search these domains

max_uses: Option<u32>

Maximum number of searches per request

user_location: Option<UserLocation>

User’s location for localizing search results

cache_control: Option<CacheControl>

Cache control for this tool definition

Implementations

impl WebSearchTool

pub fn new() -> Self

Create a new WebSearchTool with the latest tool version.

pub fn with_allowed_domains(self, domains: Vec<String>) -> Self

Restrict searches to the specified domains.

pub fn with_blocked_domains(self, domains: Vec<String>) -> Self

Block searches from the specified domains.

pub fn with_max_uses(self, max: u32) -> Self

Set the maximum number of web searches allowed per request.

pub fn with_user_location(self, location: UserLocation) -> Self

Set the user’s location for localizing search results.

pub fn with_cache_control(self, cache_control: CacheControl) -> Self

Set cache control for this tool definition.

Trait Implementations

impl Clone for WebSearchTool

fn clone(&self) -> WebSearchTool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebSearchTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebSearchTool

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSearchTool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<WebSearchTool> for ToolDefinition

fn from(tool: WebSearchTool) -> ToolDefinition

Converts to this type from the input type.

impl Serialize for WebSearchTool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.