1use std::sync::Arc;
2
3use crate::{
4 AgentTool, ToolCallEventStream, ToolPermissionDecision, decide_permission_from_settings,
5};
6use agent_client_protocol as acp;
7use agent_settings::AgentSettings;
8use anyhow::{Result, anyhow};
9use cloud_llm_client::WebSearchResponse;
10use futures::FutureExt as _;
11use gpui::{App, AppContext, Task};
12use language_model::{
13 LanguageModelProviderId, LanguageModelToolResultContent, ZED_CLOUD_PROVIDER_ID,
14};
15use schemars::JsonSchema;
16use serde::{Deserialize, Serialize};
17use settings::Settings;
18use ui::prelude::*;
19use util::markdown::MarkdownInlineCode;
20use web_search::WebSearchRegistry;
21
22/// Search the web for information using your query.
23/// Use this when you need real-time information, facts, or data that might not be in your training.
24/// Results will include snippets and links from relevant web pages.
25#[derive(Debug, Serialize, Deserialize, JsonSchema)]
26pub struct WebSearchToolInput {
27 /// The search term or question to query on the web.
28 query: String,
29}
30
31#[derive(Debug, Serialize, Deserialize)]
32#[serde(transparent)]
33pub struct WebSearchToolOutput(WebSearchResponse);
34
35impl From<WebSearchToolOutput> for LanguageModelToolResultContent {
36 fn from(value: WebSearchToolOutput) -> Self {
37 serde_json::to_string(&value.0)
38 .expect("Failed to serialize WebSearchResponse")
39 .into()
40 }
41}
42
43pub struct WebSearchTool;
44
45impl AgentTool for WebSearchTool {
46 type Input = WebSearchToolInput;
47 type Output = WebSearchToolOutput;
48
49 fn name() -> &'static str {
50 "web_search"
51 }
52
53 fn kind() -> acp::ToolKind {
54 acp::ToolKind::Fetch
55 }
56
57 fn initial_title(
58 &self,
59 _input: Result<Self::Input, serde_json::Value>,
60 _cx: &mut App,
61 ) -> SharedString {
62 "Searching the Web".into()
63 }
64
65 /// We currently only support Zed Cloud as a provider.
66 fn supports_provider(provider: &LanguageModelProviderId) -> bool {
67 provider == &ZED_CLOUD_PROVIDER_ID
68 }
69
70 fn run(
71 self: Arc<Self>,
72 input: Self::Input,
73 event_stream: ToolCallEventStream,
74 cx: &mut App,
75 ) -> Task<Result<Self::Output>> {
76 let settings = AgentSettings::get_global(cx);
77 let decision = decide_permission_from_settings(Self::name(), &input.query, settings);
78
79 let authorize = match decision {
80 ToolPermissionDecision::Allow => None,
81 ToolPermissionDecision::Deny(reason) => {
82 return Task::ready(Err(anyhow!("{}", reason)));
83 }
84 ToolPermissionDecision::Confirm => Some(event_stream.authorize(
85 format!("Search the web for {}", MarkdownInlineCode(&input.query)),
86 cx,
87 )),
88 };
89
90 let Some(provider) = WebSearchRegistry::read_global(cx).active_provider() else {
91 return Task::ready(Err(anyhow!("Web search is not available.")));
92 };
93
94 let search_task = provider.search(input.query, cx);
95 cx.background_spawn(async move {
96 if let Some(authorize) = authorize {
97 authorize.await?;
98 }
99
100 let response = futures::select! {
101 result = search_task.fuse() => {
102 match result {
103 Ok(response) => response,
104 Err(err) => {
105 event_stream
106 .update_fields(acp::ToolCallUpdateFields::new().title("Web Search Failed"));
107 return Err(err);
108 }
109 }
110 }
111 _ = event_stream.cancelled_by_user().fuse() => {
112 anyhow::bail!("Web search cancelled by user");
113 }
114 };
115
116 emit_update(&response, &event_stream);
117 Ok(WebSearchToolOutput(response))
118 })
119 }
120
121 fn replay(
122 &self,
123 _input: Self::Input,
124 output: Self::Output,
125 event_stream: ToolCallEventStream,
126 _cx: &mut App,
127 ) -> Result<()> {
128 emit_update(&output.0, &event_stream);
129 Ok(())
130 }
131}
132
133fn emit_update(response: &WebSearchResponse, event_stream: &ToolCallEventStream) {
134 let result_text = if response.results.len() == 1 {
135 "1 result".to_string()
136 } else {
137 format!("{} results", response.results.len())
138 };
139 event_stream.update_fields(
140 acp::ToolCallUpdateFields::new()
141 .title(format!("Searched the web: {result_text}"))
142 .content(
143 response
144 .results
145 .iter()
146 .map(|result| {
147 acp::ToolCallContent::Content(acp::Content::new(
148 acp::ContentBlock::ResourceLink(
149 acp::ResourceLink::new(result.title.clone(), result.url.clone())
150 .title(result.title.clone())
151 .description(result.text.clone()),
152 ),
153 ))
154 })
155 .collect::<Vec<_>>(),
156 ),
157 );
158}