1use crate::{
2 ContextServerRegistry, CopyPathTool, CreateDirectoryTool, DbLanguageModel, DbThread,
3 DeletePathTool, DiagnosticsTool, EditFileTool, FetchTool, FindPathTool, GrepTool,
4 ListDirectoryTool, MovePathTool, NowTool, OpenTool, ReadFileTool, SystemPromptTemplate,
5 Template, Templates, TerminalTool, ThinkingTool, WebSearchTool,
6};
7use acp_thread::{MentionUri, UserMessageId};
8use action_log::ActionLog;
9use agent::thread::{GitState, ProjectSnapshot, WorktreeSnapshot};
10use agent_client_protocol as acp;
11use agent_settings::{
12 AgentProfileId, AgentSettings, CompletionMode, SUMMARIZE_THREAD_DETAILED_PROMPT,
13 SUMMARIZE_THREAD_PROMPT,
14};
15use anyhow::{Context as _, Result, anyhow};
16use assistant_tool::adapt_schema_to_format;
17use chrono::{DateTime, Utc};
18use client::{ModelRequestUsage, RequestUsage};
19use cloud_llm_client::{CompletionIntent, CompletionRequestStatus, UsageLimit};
20use collections::{HashMap, IndexMap};
21use fs::Fs;
22use futures::{
23 FutureExt,
24 channel::{mpsc, oneshot},
25 future::Shared,
26 stream::FuturesUnordered,
27};
28use git::repository::DiffType;
29use gpui::{
30 App, AppContext, AsyncApp, Context, Entity, EventEmitter, SharedString, Task, WeakEntity,
31};
32use language_model::{
33 LanguageModel, LanguageModelCompletionError, LanguageModelCompletionEvent, LanguageModelExt,
34 LanguageModelImage, LanguageModelProviderId, LanguageModelRegistry, LanguageModelRequest,
35 LanguageModelRequestMessage, LanguageModelRequestTool, LanguageModelToolResult,
36 LanguageModelToolResultContent, LanguageModelToolSchemaFormat, LanguageModelToolUse,
37 LanguageModelToolUseId, Role, SelectedModel, StopReason, TokenUsage,
38};
39use project::{
40 Project,
41 git_store::{GitStore, RepositoryState},
42};
43use prompt_store::ProjectContext;
44use schemars::{JsonSchema, Schema};
45use serde::{Deserialize, Serialize};
46use settings::{Settings, update_settings_file};
47use smol::stream::StreamExt;
48use std::{
49 collections::BTreeMap,
50 path::Path,
51 sync::Arc,
52 time::{Duration, Instant},
53};
54use std::{fmt::Write, ops::Range};
55use util::{ResultExt, markdown::MarkdownCodeBlock};
56use uuid::Uuid;
57
58const TOOL_CANCELED_MESSAGE: &str = "Tool canceled by user";
59
60/// The ID of the user prompt that initiated a request.
61///
62/// This equates to the user physically submitting a message to the model (e.g., by pressing the Enter key).
63#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Serialize, Deserialize)]
64pub struct PromptId(Arc<str>);
65
66impl PromptId {
67 pub fn new() -> Self {
68 Self(Uuid::new_v4().to_string().into())
69 }
70}
71
72impl std::fmt::Display for PromptId {
73 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
74 write!(f, "{}", self.0)
75 }
76}
77
78pub(crate) const MAX_RETRY_ATTEMPTS: u8 = 4;
79pub(crate) const BASE_RETRY_DELAY: Duration = Duration::from_secs(5);
80
81#[derive(Debug, Clone)]
82enum RetryStrategy {
83 ExponentialBackoff {
84 initial_delay: Duration,
85 max_attempts: u8,
86 },
87 Fixed {
88 delay: Duration,
89 max_attempts: u8,
90 },
91}
92
93#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
94pub enum Message {
95 User(UserMessage),
96 Agent(AgentMessage),
97 Resume,
98}
99
100impl Message {
101 pub fn as_agent_message(&self) -> Option<&AgentMessage> {
102 match self {
103 Message::Agent(agent_message) => Some(agent_message),
104 _ => None,
105 }
106 }
107
108 pub fn to_request(&self) -> Vec<LanguageModelRequestMessage> {
109 match self {
110 Message::User(message) => vec![message.to_request()],
111 Message::Agent(message) => message.to_request(),
112 Message::Resume => vec![LanguageModelRequestMessage {
113 role: Role::User,
114 content: vec!["Continue where you left off".into()],
115 cache: false,
116 }],
117 }
118 }
119
120 pub fn to_markdown(&self) -> String {
121 match self {
122 Message::User(message) => message.to_markdown(),
123 Message::Agent(message) => message.to_markdown(),
124 Message::Resume => "[resumed after tool use limit was reached]".into(),
125 }
126 }
127
128 pub fn role(&self) -> Role {
129 match self {
130 Message::User(_) | Message::Resume => Role::User,
131 Message::Agent(_) => Role::Assistant,
132 }
133 }
134}
135
136#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
137pub struct UserMessage {
138 pub id: UserMessageId,
139 pub content: Vec<UserMessageContent>,
140}
141
142#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
143pub enum UserMessageContent {
144 Text(String),
145 Mention { uri: MentionUri, content: String },
146 Image(LanguageModelImage),
147}
148
149impl UserMessage {
150 pub fn to_markdown(&self) -> String {
151 let mut markdown = String::from("## User\n\n");
152
153 for content in &self.content {
154 match content {
155 UserMessageContent::Text(text) => {
156 markdown.push_str(text);
157 markdown.push('\n');
158 }
159 UserMessageContent::Image(_) => {
160 markdown.push_str("<image />\n");
161 }
162 UserMessageContent::Mention { uri, content } => {
163 if !content.is_empty() {
164 let _ = write!(&mut markdown, "{}\n\n{}\n", uri.as_link(), content);
165 } else {
166 let _ = write!(&mut markdown, "{}\n", uri.as_link());
167 }
168 }
169 }
170 }
171
172 markdown
173 }
174
175 fn to_request(&self) -> LanguageModelRequestMessage {
176 let mut message = LanguageModelRequestMessage {
177 role: Role::User,
178 content: Vec::with_capacity(self.content.len()),
179 cache: false,
180 };
181
182 const OPEN_CONTEXT: &str = "<context>\n\
183 The following items were attached by the user. \
184 They are up-to-date and don't need to be re-read.\n\n";
185
186 const OPEN_FILES_TAG: &str = "<files>";
187 const OPEN_DIRECTORIES_TAG: &str = "<directories>";
188 const OPEN_SYMBOLS_TAG: &str = "<symbols>";
189 const OPEN_THREADS_TAG: &str = "<threads>";
190 const OPEN_FETCH_TAG: &str = "<fetched_urls>";
191 const OPEN_RULES_TAG: &str =
192 "<rules>\nThe user has specified the following rules that should be applied:\n";
193
194 let mut file_context = OPEN_FILES_TAG.to_string();
195 let mut directory_context = OPEN_DIRECTORIES_TAG.to_string();
196 let mut symbol_context = OPEN_SYMBOLS_TAG.to_string();
197 let mut thread_context = OPEN_THREADS_TAG.to_string();
198 let mut fetch_context = OPEN_FETCH_TAG.to_string();
199 let mut rules_context = OPEN_RULES_TAG.to_string();
200
201 for chunk in &self.content {
202 let chunk = match chunk {
203 UserMessageContent::Text(text) => {
204 language_model::MessageContent::Text(text.clone())
205 }
206 UserMessageContent::Image(value) => {
207 language_model::MessageContent::Image(value.clone())
208 }
209 UserMessageContent::Mention { uri, content } => {
210 match uri {
211 MentionUri::File { abs_path } => {
212 write!(
213 &mut symbol_context,
214 "\n{}",
215 MarkdownCodeBlock {
216 tag: &codeblock_tag(abs_path, None),
217 text: &content.to_string(),
218 }
219 )
220 .ok();
221 }
222 MentionUri::Directory { .. } => {
223 write!(&mut directory_context, "\n{}\n", content).ok();
224 }
225 MentionUri::Symbol {
226 path, line_range, ..
227 }
228 | MentionUri::Selection {
229 path, line_range, ..
230 } => {
231 write!(
232 &mut rules_context,
233 "\n{}",
234 MarkdownCodeBlock {
235 tag: &codeblock_tag(path, Some(line_range)),
236 text: content
237 }
238 )
239 .ok();
240 }
241 MentionUri::Thread { .. } => {
242 write!(&mut thread_context, "\n{}\n", content).ok();
243 }
244 MentionUri::TextThread { .. } => {
245 write!(&mut thread_context, "\n{}\n", content).ok();
246 }
247 MentionUri::Rule { .. } => {
248 write!(
249 &mut rules_context,
250 "\n{}",
251 MarkdownCodeBlock {
252 tag: "",
253 text: content
254 }
255 )
256 .ok();
257 }
258 MentionUri::Fetch { url } => {
259 write!(&mut fetch_context, "\nFetch: {}\n\n{}", url, content).ok();
260 }
261 }
262
263 language_model::MessageContent::Text(uri.as_link().to_string())
264 }
265 };
266
267 message.content.push(chunk);
268 }
269
270 let len_before_context = message.content.len();
271
272 if file_context.len() > OPEN_FILES_TAG.len() {
273 file_context.push_str("</files>\n");
274 message
275 .content
276 .push(language_model::MessageContent::Text(file_context));
277 }
278
279 if directory_context.len() > OPEN_DIRECTORIES_TAG.len() {
280 directory_context.push_str("</directories>\n");
281 message
282 .content
283 .push(language_model::MessageContent::Text(directory_context));
284 }
285
286 if symbol_context.len() > OPEN_SYMBOLS_TAG.len() {
287 symbol_context.push_str("</symbols>\n");
288 message
289 .content
290 .push(language_model::MessageContent::Text(symbol_context));
291 }
292
293 if thread_context.len() > OPEN_THREADS_TAG.len() {
294 thread_context.push_str("</threads>\n");
295 message
296 .content
297 .push(language_model::MessageContent::Text(thread_context));
298 }
299
300 if fetch_context.len() > OPEN_FETCH_TAG.len() {
301 fetch_context.push_str("</fetched_urls>\n");
302 message
303 .content
304 .push(language_model::MessageContent::Text(fetch_context));
305 }
306
307 if rules_context.len() > OPEN_RULES_TAG.len() {
308 rules_context.push_str("</user_rules>\n");
309 message
310 .content
311 .push(language_model::MessageContent::Text(rules_context));
312 }
313
314 if message.content.len() > len_before_context {
315 message.content.insert(
316 len_before_context,
317 language_model::MessageContent::Text(OPEN_CONTEXT.into()),
318 );
319 message
320 .content
321 .push(language_model::MessageContent::Text("</context>".into()));
322 }
323
324 message
325 }
326}
327
328fn codeblock_tag(full_path: &Path, line_range: Option<&Range<u32>>) -> String {
329 let mut result = String::new();
330
331 if let Some(extension) = full_path.extension().and_then(|ext| ext.to_str()) {
332 let _ = write!(result, "{} ", extension);
333 }
334
335 let _ = write!(result, "{}", full_path.display());
336
337 if let Some(range) = line_range {
338 if range.start == range.end {
339 let _ = write!(result, ":{}", range.start + 1);
340 } else {
341 let _ = write!(result, ":{}-{}", range.start + 1, range.end + 1);
342 }
343 }
344
345 result
346}
347
348impl AgentMessage {
349 pub fn to_markdown(&self) -> String {
350 let mut markdown = String::from("## Assistant\n\n");
351
352 for content in &self.content {
353 match content {
354 AgentMessageContent::Text(text) => {
355 markdown.push_str(text);
356 markdown.push('\n');
357 }
358 AgentMessageContent::Thinking { text, .. } => {
359 markdown.push_str("<think>");
360 markdown.push_str(text);
361 markdown.push_str("</think>\n");
362 }
363 AgentMessageContent::RedactedThinking(_) => {
364 markdown.push_str("<redacted_thinking />\n")
365 }
366 AgentMessageContent::ToolUse(tool_use) => {
367 markdown.push_str(&format!(
368 "**Tool Use**: {} (ID: {})\n",
369 tool_use.name, tool_use.id
370 ));
371 markdown.push_str(&format!(
372 "{}\n",
373 MarkdownCodeBlock {
374 tag: "json",
375 text: &format!("{:#}", tool_use.input)
376 }
377 ));
378 }
379 }
380 }
381
382 for tool_result in self.tool_results.values() {
383 markdown.push_str(&format!(
384 "**Tool Result**: {} (ID: {})\n\n",
385 tool_result.tool_name, tool_result.tool_use_id
386 ));
387 if tool_result.is_error {
388 markdown.push_str("**ERROR:**\n");
389 }
390
391 match &tool_result.content {
392 LanguageModelToolResultContent::Text(text) => {
393 writeln!(markdown, "{text}\n").ok();
394 }
395 LanguageModelToolResultContent::Image(_) => {
396 writeln!(markdown, "<image />\n").ok();
397 }
398 }
399
400 if let Some(output) = tool_result.output.as_ref() {
401 writeln!(
402 markdown,
403 "**Debug Output**:\n\n```json\n{}\n```\n",
404 serde_json::to_string_pretty(output).unwrap()
405 )
406 .unwrap();
407 }
408 }
409
410 markdown
411 }
412
413 pub fn to_request(&self) -> Vec<LanguageModelRequestMessage> {
414 let mut assistant_message = LanguageModelRequestMessage {
415 role: Role::Assistant,
416 content: Vec::with_capacity(self.content.len()),
417 cache: false,
418 };
419 for chunk in &self.content {
420 let chunk = match chunk {
421 AgentMessageContent::Text(text) => {
422 language_model::MessageContent::Text(text.clone())
423 }
424 AgentMessageContent::Thinking { text, signature } => {
425 language_model::MessageContent::Thinking {
426 text: text.clone(),
427 signature: signature.clone(),
428 }
429 }
430 AgentMessageContent::RedactedThinking(value) => {
431 language_model::MessageContent::RedactedThinking(value.clone())
432 }
433 AgentMessageContent::ToolUse(value) => {
434 language_model::MessageContent::ToolUse(value.clone())
435 }
436 };
437 assistant_message.content.push(chunk);
438 }
439
440 let mut user_message = LanguageModelRequestMessage {
441 role: Role::User,
442 content: Vec::new(),
443 cache: false,
444 };
445
446 for tool_result in self.tool_results.values() {
447 user_message
448 .content
449 .push(language_model::MessageContent::ToolResult(
450 tool_result.clone(),
451 ));
452 }
453
454 let mut messages = Vec::new();
455 if !assistant_message.content.is_empty() {
456 messages.push(assistant_message);
457 }
458 if !user_message.content.is_empty() {
459 messages.push(user_message);
460 }
461 messages
462 }
463}
464
465#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
466pub struct AgentMessage {
467 pub content: Vec<AgentMessageContent>,
468 pub tool_results: IndexMap<LanguageModelToolUseId, LanguageModelToolResult>,
469}
470
471#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
472pub enum AgentMessageContent {
473 Text(String),
474 Thinking {
475 text: String,
476 signature: Option<String>,
477 },
478 RedactedThinking(String),
479 ToolUse(LanguageModelToolUse),
480}
481
482#[derive(Debug)]
483pub enum ThreadEvent {
484 UserMessage(UserMessage),
485 AgentText(String),
486 AgentThinking(String),
487 ToolCall(acp::ToolCall),
488 ToolCallUpdate(acp_thread::ToolCallUpdate),
489 ToolCallAuthorization(ToolCallAuthorization),
490 TitleUpdate(SharedString),
491 Retry(acp_thread::RetryStatus),
492 Stop(acp::StopReason),
493}
494
495#[derive(Debug)]
496pub struct ToolCallAuthorization {
497 pub tool_call: acp::ToolCallUpdate,
498 pub options: Vec<acp::PermissionOption>,
499 pub response: oneshot::Sender<acp::PermissionOptionId>,
500}
501
502pub struct Thread {
503 id: acp::SessionId,
504 prompt_id: PromptId,
505 updated_at: DateTime<Utc>,
506 title: Option<SharedString>,
507 summary: Option<SharedString>,
508 messages: Vec<Message>,
509 completion_mode: CompletionMode,
510 /// Holds the task that handles agent interaction until the end of the turn.
511 /// Survives across multiple requests as the model performs tool calls and
512 /// we run tools, report their results.
513 running_turn: Option<RunningTurn>,
514 pending_message: Option<AgentMessage>,
515 tools: BTreeMap<SharedString, Arc<dyn AnyAgentTool>>,
516 tool_use_limit_reached: bool,
517 request_token_usage: HashMap<UserMessageId, language_model::TokenUsage>,
518 #[allow(unused)]
519 cumulative_token_usage: TokenUsage,
520 #[allow(unused)]
521 initial_project_snapshot: Shared<Task<Option<Arc<ProjectSnapshot>>>>,
522 context_server_registry: Entity<ContextServerRegistry>,
523 profile_id: AgentProfileId,
524 project_context: Entity<ProjectContext>,
525 templates: Arc<Templates>,
526 model: Option<Arc<dyn LanguageModel>>,
527 summarization_model: Option<Arc<dyn LanguageModel>>,
528 pub(crate) project: Entity<Project>,
529 pub(crate) action_log: Entity<ActionLog>,
530}
531
532impl Thread {
533 pub fn new(
534 project: Entity<Project>,
535 project_context: Entity<ProjectContext>,
536 context_server_registry: Entity<ContextServerRegistry>,
537 action_log: Entity<ActionLog>,
538 templates: Arc<Templates>,
539 model: Option<Arc<dyn LanguageModel>>,
540 cx: &mut Context<Self>,
541 ) -> Self {
542 let profile_id = AgentSettings::get_global(cx).default_profile.clone();
543 Self {
544 id: acp::SessionId(uuid::Uuid::new_v4().to_string().into()),
545 prompt_id: PromptId::new(),
546 updated_at: Utc::now(),
547 title: None,
548 summary: None,
549 messages: Vec::new(),
550 completion_mode: AgentSettings::get_global(cx).preferred_completion_mode,
551 running_turn: None,
552 pending_message: None,
553 tools: BTreeMap::default(),
554 tool_use_limit_reached: false,
555 request_token_usage: HashMap::default(),
556 cumulative_token_usage: TokenUsage::default(),
557 initial_project_snapshot: {
558 let project_snapshot = Self::project_snapshot(project.clone(), cx);
559 cx.foreground_executor()
560 .spawn(async move { Some(project_snapshot.await) })
561 .shared()
562 },
563 context_server_registry,
564 profile_id,
565 project_context,
566 templates,
567 model,
568 summarization_model: None,
569 project,
570 action_log,
571 }
572 }
573
574 pub fn id(&self) -> &acp::SessionId {
575 &self.id
576 }
577
578 pub fn replay(
579 &mut self,
580 cx: &mut Context<Self>,
581 ) -> mpsc::UnboundedReceiver<Result<ThreadEvent>> {
582 let (tx, rx) = mpsc::unbounded();
583 let stream = ThreadEventStream(tx);
584 for message in &self.messages {
585 match message {
586 Message::User(user_message) => stream.send_user_message(user_message),
587 Message::Agent(assistant_message) => {
588 for content in &assistant_message.content {
589 match content {
590 AgentMessageContent::Text(text) => stream.send_text(text),
591 AgentMessageContent::Thinking { text, .. } => {
592 stream.send_thinking(text)
593 }
594 AgentMessageContent::RedactedThinking(_) => {}
595 AgentMessageContent::ToolUse(tool_use) => {
596 self.replay_tool_call(
597 tool_use,
598 assistant_message.tool_results.get(&tool_use.id),
599 &stream,
600 cx,
601 );
602 }
603 }
604 }
605 }
606 Message::Resume => {}
607 }
608 }
609 rx
610 }
611
612 fn replay_tool_call(
613 &self,
614 tool_use: &LanguageModelToolUse,
615 tool_result: Option<&LanguageModelToolResult>,
616 stream: &ThreadEventStream,
617 cx: &mut Context<Self>,
618 ) {
619 let Some(tool) = self.tools.get(tool_use.name.as_ref()) else {
620 stream
621 .0
622 .unbounded_send(Ok(ThreadEvent::ToolCall(acp::ToolCall {
623 id: acp::ToolCallId(tool_use.id.to_string().into()),
624 title: tool_use.name.to_string(),
625 kind: acp::ToolKind::Other,
626 status: acp::ToolCallStatus::Failed,
627 content: Vec::new(),
628 locations: Vec::new(),
629 raw_input: Some(tool_use.input.clone()),
630 raw_output: None,
631 })))
632 .ok();
633 return;
634 };
635
636 let title = tool.initial_title(tool_use.input.clone());
637 let kind = tool.kind();
638 stream.send_tool_call(&tool_use.id, title, kind, tool_use.input.clone());
639
640 let output = tool_result
641 .as_ref()
642 .and_then(|result| result.output.clone());
643 if let Some(output) = output.clone() {
644 let tool_event_stream = ToolCallEventStream::new(
645 tool_use.id.clone(),
646 stream.clone(),
647 Some(self.project.read(cx).fs().clone()),
648 );
649 tool.replay(tool_use.input.clone(), output, tool_event_stream, cx)
650 .log_err();
651 }
652
653 stream.update_tool_call_fields(
654 &tool_use.id,
655 acp::ToolCallUpdateFields {
656 status: Some(acp::ToolCallStatus::Completed),
657 raw_output: output,
658 ..Default::default()
659 },
660 );
661 }
662
663 pub fn from_db(
664 id: acp::SessionId,
665 db_thread: DbThread,
666 project: Entity<Project>,
667 project_context: Entity<ProjectContext>,
668 context_server_registry: Entity<ContextServerRegistry>,
669 action_log: Entity<ActionLog>,
670 templates: Arc<Templates>,
671 cx: &mut Context<Self>,
672 ) -> Self {
673 let profile_id = db_thread
674 .profile
675 .unwrap_or_else(|| AgentSettings::get_global(cx).default_profile.clone());
676 let model = LanguageModelRegistry::global(cx).update(cx, |registry, cx| {
677 db_thread
678 .model
679 .and_then(|model| {
680 let model = SelectedModel {
681 provider: model.provider.clone().into(),
682 model: model.model.clone().into(),
683 };
684 registry.select_model(&model, cx)
685 })
686 .or_else(|| registry.default_model())
687 .map(|model| model.model)
688 });
689
690 Self {
691 id,
692 prompt_id: PromptId::new(),
693 title: if db_thread.title.is_empty() {
694 None
695 } else {
696 Some(db_thread.title.clone())
697 },
698 summary: db_thread.detailed_summary,
699 messages: db_thread.messages,
700 completion_mode: db_thread.completion_mode.unwrap_or_default(),
701 running_turn: None,
702 pending_message: None,
703 tools: BTreeMap::default(),
704 tool_use_limit_reached: false,
705 request_token_usage: db_thread.request_token_usage.clone(),
706 cumulative_token_usage: db_thread.cumulative_token_usage,
707 initial_project_snapshot: Task::ready(db_thread.initial_project_snapshot).shared(),
708 context_server_registry,
709 profile_id,
710 project_context,
711 templates,
712 model,
713 summarization_model: None,
714 project,
715 action_log,
716 updated_at: db_thread.updated_at,
717 }
718 }
719
720 pub fn to_db(&self, cx: &App) -> Task<DbThread> {
721 let initial_project_snapshot = self.initial_project_snapshot.clone();
722 let mut thread = DbThread {
723 title: self.title.clone().unwrap_or_default(),
724 messages: self.messages.clone(),
725 updated_at: self.updated_at,
726 detailed_summary: self.summary.clone(),
727 initial_project_snapshot: None,
728 cumulative_token_usage: self.cumulative_token_usage,
729 request_token_usage: self.request_token_usage.clone(),
730 model: self.model.as_ref().map(|model| DbLanguageModel {
731 provider: model.provider_id().to_string(),
732 model: model.name().0.to_string(),
733 }),
734 completion_mode: Some(self.completion_mode),
735 profile: Some(self.profile_id.clone()),
736 };
737
738 cx.background_spawn(async move {
739 let initial_project_snapshot = initial_project_snapshot.await;
740 thread.initial_project_snapshot = initial_project_snapshot;
741 thread
742 })
743 }
744
745 /// Create a snapshot of the current project state including git information and unsaved buffers.
746 fn project_snapshot(
747 project: Entity<Project>,
748 cx: &mut Context<Self>,
749 ) -> Task<Arc<agent::thread::ProjectSnapshot>> {
750 let git_store = project.read(cx).git_store().clone();
751 let worktree_snapshots: Vec<_> = project
752 .read(cx)
753 .visible_worktrees(cx)
754 .map(|worktree| Self::worktree_snapshot(worktree, git_store.clone(), cx))
755 .collect();
756
757 cx.spawn(async move |_, cx| {
758 let worktree_snapshots = futures::future::join_all(worktree_snapshots).await;
759
760 let mut unsaved_buffers = Vec::new();
761 cx.update(|app_cx| {
762 let buffer_store = project.read(app_cx).buffer_store();
763 for buffer_handle in buffer_store.read(app_cx).buffers() {
764 let buffer = buffer_handle.read(app_cx);
765 if buffer.is_dirty()
766 && let Some(file) = buffer.file()
767 {
768 let path = file.path().to_string_lossy().to_string();
769 unsaved_buffers.push(path);
770 }
771 }
772 })
773 .ok();
774
775 Arc::new(ProjectSnapshot {
776 worktree_snapshots,
777 unsaved_buffer_paths: unsaved_buffers,
778 timestamp: Utc::now(),
779 })
780 })
781 }
782
783 fn worktree_snapshot(
784 worktree: Entity<project::Worktree>,
785 git_store: Entity<GitStore>,
786 cx: &App,
787 ) -> Task<agent::thread::WorktreeSnapshot> {
788 cx.spawn(async move |cx| {
789 // Get worktree path and snapshot
790 let worktree_info = cx.update(|app_cx| {
791 let worktree = worktree.read(app_cx);
792 let path = worktree.abs_path().to_string_lossy().to_string();
793 let snapshot = worktree.snapshot();
794 (path, snapshot)
795 });
796
797 let Ok((worktree_path, _snapshot)) = worktree_info else {
798 return WorktreeSnapshot {
799 worktree_path: String::new(),
800 git_state: None,
801 };
802 };
803
804 let git_state = git_store
805 .update(cx, |git_store, cx| {
806 git_store
807 .repositories()
808 .values()
809 .find(|repo| {
810 repo.read(cx)
811 .abs_path_to_repo_path(&worktree.read(cx).abs_path())
812 .is_some()
813 })
814 .cloned()
815 })
816 .ok()
817 .flatten()
818 .map(|repo| {
819 repo.update(cx, |repo, _| {
820 let current_branch =
821 repo.branch.as_ref().map(|branch| branch.name().to_owned());
822 repo.send_job(None, |state, _| async move {
823 let RepositoryState::Local { backend, .. } = state else {
824 return GitState {
825 remote_url: None,
826 head_sha: None,
827 current_branch,
828 diff: None,
829 };
830 };
831
832 let remote_url = backend.remote_url("origin");
833 let head_sha = backend.head_sha().await;
834 let diff = backend.diff(DiffType::HeadToWorktree).await.ok();
835
836 GitState {
837 remote_url,
838 head_sha,
839 current_branch,
840 diff,
841 }
842 })
843 })
844 });
845
846 let git_state = match git_state {
847 Some(git_state) => match git_state.ok() {
848 Some(git_state) => git_state.await.ok(),
849 None => None,
850 },
851 None => None,
852 };
853
854 WorktreeSnapshot {
855 worktree_path,
856 git_state,
857 }
858 })
859 }
860
861 pub fn project_context(&self) -> &Entity<ProjectContext> {
862 &self.project_context
863 }
864
865 pub fn project(&self) -> &Entity<Project> {
866 &self.project
867 }
868
869 pub fn action_log(&self) -> &Entity<ActionLog> {
870 &self.action_log
871 }
872
873 pub fn model(&self) -> Option<&Arc<dyn LanguageModel>> {
874 self.model.as_ref()
875 }
876
877 pub fn set_model(&mut self, model: Arc<dyn LanguageModel>, cx: &mut Context<Self>) {
878 let old_usage = self.latest_token_usage();
879 self.model = Some(model);
880 let new_usage = self.latest_token_usage();
881 if old_usage != new_usage {
882 cx.emit(TokenUsageUpdated(new_usage));
883 }
884 cx.notify()
885 }
886
887 pub fn set_summarization_model(
888 &mut self,
889 model: Option<Arc<dyn LanguageModel>>,
890 cx: &mut Context<Self>,
891 ) {
892 self.summarization_model = model;
893 cx.notify()
894 }
895
896 pub fn completion_mode(&self) -> CompletionMode {
897 self.completion_mode
898 }
899
900 pub fn set_completion_mode(&mut self, mode: CompletionMode, cx: &mut Context<Self>) {
901 let old_usage = self.latest_token_usage();
902 self.completion_mode = mode;
903 let new_usage = self.latest_token_usage();
904 if old_usage != new_usage {
905 cx.emit(TokenUsageUpdated(new_usage));
906 }
907 cx.notify()
908 }
909
910 #[cfg(any(test, feature = "test-support"))]
911 pub fn last_message(&self) -> Option<Message> {
912 if let Some(message) = self.pending_message.clone() {
913 Some(Message::Agent(message))
914 } else {
915 self.messages.last().cloned()
916 }
917 }
918
919 pub fn add_default_tools(&mut self, cx: &mut Context<Self>) {
920 let language_registry = self.project.read(cx).languages().clone();
921 self.add_tool(CopyPathTool::new(self.project.clone()));
922 self.add_tool(CreateDirectoryTool::new(self.project.clone()));
923 self.add_tool(DeletePathTool::new(
924 self.project.clone(),
925 self.action_log.clone(),
926 ));
927 self.add_tool(DiagnosticsTool::new(self.project.clone()));
928 self.add_tool(EditFileTool::new(cx.weak_entity(), language_registry));
929 self.add_tool(FetchTool::new(self.project.read(cx).client().http_client()));
930 self.add_tool(FindPathTool::new(self.project.clone()));
931 self.add_tool(GrepTool::new(self.project.clone()));
932 self.add_tool(ListDirectoryTool::new(self.project.clone()));
933 self.add_tool(MovePathTool::new(self.project.clone()));
934 self.add_tool(NowTool);
935 self.add_tool(OpenTool::new(self.project.clone()));
936 self.add_tool(ReadFileTool::new(
937 self.project.clone(),
938 self.action_log.clone(),
939 ));
940 self.add_tool(TerminalTool::new(self.project.clone(), cx));
941 self.add_tool(ThinkingTool);
942 self.add_tool(WebSearchTool); // TODO: Enable this only if it's a zed model.
943 }
944
945 pub fn add_tool(&mut self, tool: impl AgentTool) {
946 self.tools.insert(tool.name(), tool.erase());
947 }
948
949 pub fn remove_tool(&mut self, name: &str) -> bool {
950 self.tools.remove(name).is_some()
951 }
952
953 pub fn profile(&self) -> &AgentProfileId {
954 &self.profile_id
955 }
956
957 pub fn set_profile(&mut self, profile_id: AgentProfileId) {
958 self.profile_id = profile_id;
959 }
960
961 pub fn cancel(&mut self, cx: &mut Context<Self>) {
962 if let Some(running_turn) = self.running_turn.take() {
963 running_turn.cancel();
964 }
965 self.flush_pending_message(cx);
966 }
967
968 fn update_token_usage(&mut self, update: language_model::TokenUsage, cx: &mut Context<Self>) {
969 let Some(last_user_message) = self.last_user_message() else {
970 return;
971 };
972
973 self.request_token_usage
974 .insert(last_user_message.id.clone(), update);
975 cx.emit(TokenUsageUpdated(self.latest_token_usage()));
976 cx.notify();
977 }
978
979 pub fn truncate(&mut self, message_id: UserMessageId, cx: &mut Context<Self>) -> Result<()> {
980 self.cancel(cx);
981 let Some(position) = self.messages.iter().position(
982 |msg| matches!(msg, Message::User(UserMessage { id, .. }) if id == &message_id),
983 ) else {
984 return Err(anyhow!("Message not found"));
985 };
986
987 for message in self.messages.drain(position..) {
988 match message {
989 Message::User(message) => {
990 self.request_token_usage.remove(&message.id);
991 }
992 Message::Agent(_) | Message::Resume => {}
993 }
994 }
995 self.summary = None;
996 cx.notify();
997 Ok(())
998 }
999
1000 pub fn latest_token_usage(&self) -> Option<acp_thread::TokenUsage> {
1001 let last_user_message = self.last_user_message()?;
1002 let tokens = self.request_token_usage.get(&last_user_message.id)?;
1003 let model = self.model.clone()?;
1004
1005 Some(acp_thread::TokenUsage {
1006 max_tokens: model.max_token_count_for_mode(self.completion_mode.into()),
1007 used_tokens: tokens.total_tokens(),
1008 })
1009 }
1010
1011 pub fn resume(
1012 &mut self,
1013 cx: &mut Context<Self>,
1014 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>> {
1015 anyhow::ensure!(
1016 self.tool_use_limit_reached,
1017 "can only resume after tool use limit is reached"
1018 );
1019
1020 self.messages.push(Message::Resume);
1021 cx.notify();
1022
1023 log::info!("Total messages in thread: {}", self.messages.len());
1024 self.run_turn(cx)
1025 }
1026
1027 /// Sending a message results in the model streaming a response, which could include tool calls.
1028 /// After calling tools, the model will stops and waits for any outstanding tool calls to be completed and their results sent.
1029 /// The returned channel will report all the occurrences in which the model stops before erroring or ending its turn.
1030 pub fn send<T>(
1031 &mut self,
1032 id: UserMessageId,
1033 content: impl IntoIterator<Item = T>,
1034 cx: &mut Context<Self>,
1035 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>>
1036 where
1037 T: Into<UserMessageContent>,
1038 {
1039 let model = self.model().context("No language model configured")?;
1040
1041 log::info!("Thread::send called with model: {:?}", model.name());
1042 self.advance_prompt_id();
1043
1044 let content = content.into_iter().map(Into::into).collect::<Vec<_>>();
1045 log::debug!("Thread::send content: {:?}", content);
1046
1047 self.messages
1048 .push(Message::User(UserMessage { id, content }));
1049 cx.notify();
1050
1051 log::info!("Total messages in thread: {}", self.messages.len());
1052 self.run_turn(cx)
1053 }
1054
1055 fn run_turn(
1056 &mut self,
1057 cx: &mut Context<Self>,
1058 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>> {
1059 self.cancel(cx);
1060
1061 let model = self.model.clone().context("No language model configured")?;
1062 let (events_tx, events_rx) = mpsc::unbounded::<Result<ThreadEvent>>();
1063 let event_stream = ThreadEventStream(events_tx);
1064 let message_ix = self.messages.len().saturating_sub(1);
1065 self.tool_use_limit_reached = false;
1066 self.summary = None;
1067 self.running_turn = Some(RunningTurn {
1068 event_stream: event_stream.clone(),
1069 _task: cx.spawn(async move |this, cx| {
1070 log::info!("Starting agent turn execution");
1071 let turn_result: Result<StopReason> = async {
1072 let mut completion_intent = CompletionIntent::UserPrompt;
1073 loop {
1074 log::debug!(
1075 "Building completion request with intent: {:?}",
1076 completion_intent
1077 );
1078 let request = this.update(cx, |this, cx| {
1079 this.build_completion_request(completion_intent, cx)
1080 })??;
1081
1082 log::info!("Calling model.stream_completion");
1083
1084 let mut tool_use_limit_reached = false;
1085 let mut refused = false;
1086 let mut reached_max_tokens = false;
1087 let mut tool_uses = Self::stream_completion_with_retries(
1088 this.clone(),
1089 model.clone(),
1090 request,
1091 &event_stream,
1092 &mut tool_use_limit_reached,
1093 &mut refused,
1094 &mut reached_max_tokens,
1095 cx,
1096 )
1097 .await?;
1098
1099 if refused {
1100 return Ok(StopReason::Refusal);
1101 } else if reached_max_tokens {
1102 return Ok(StopReason::MaxTokens);
1103 }
1104
1105 let end_turn = tool_uses.is_empty();
1106 while let Some(tool_result) = tool_uses.next().await {
1107 log::info!("Tool finished {:?}", tool_result);
1108
1109 event_stream.update_tool_call_fields(
1110 &tool_result.tool_use_id,
1111 acp::ToolCallUpdateFields {
1112 status: Some(if tool_result.is_error {
1113 acp::ToolCallStatus::Failed
1114 } else {
1115 acp::ToolCallStatus::Completed
1116 }),
1117 raw_output: tool_result.output.clone(),
1118 ..Default::default()
1119 },
1120 );
1121 this.update(cx, |this, _cx| {
1122 this.pending_message()
1123 .tool_results
1124 .insert(tool_result.tool_use_id.clone(), tool_result);
1125 })
1126 .ok();
1127 }
1128
1129 if tool_use_limit_reached {
1130 log::info!("Tool use limit reached, completing turn");
1131 this.update(cx, |this, _cx| this.tool_use_limit_reached = true)?;
1132 return Err(language_model::ToolUseLimitReachedError.into());
1133 } else if end_turn {
1134 log::info!("No tool uses found, completing turn");
1135 return Ok(StopReason::EndTurn);
1136 } else {
1137 this.update(cx, |this, cx| this.flush_pending_message(cx))?;
1138 completion_intent = CompletionIntent::ToolResults;
1139 }
1140 }
1141 }
1142 .await;
1143 _ = this.update(cx, |this, cx| this.flush_pending_message(cx));
1144
1145 match turn_result {
1146 Ok(reason) => {
1147 log::info!("Turn execution completed: {:?}", reason);
1148
1149 let update_title = this
1150 .update(cx, |this, cx| this.update_title(&event_stream, cx))
1151 .ok()
1152 .flatten();
1153 if let Some(update_title) = update_title {
1154 update_title.await.context("update title failed").log_err();
1155 }
1156
1157 event_stream.send_stop(reason);
1158 if reason == StopReason::Refusal {
1159 _ = this.update(cx, |this, _| this.messages.truncate(message_ix));
1160 }
1161 }
1162 Err(error) => {
1163 log::error!("Turn execution failed: {:?}", error);
1164 event_stream.send_error(error);
1165 }
1166 }
1167
1168 _ = this.update(cx, |this, _| this.running_turn.take());
1169 }),
1170 });
1171 Ok(events_rx)
1172 }
1173
1174 async fn stream_completion_with_retries(
1175 this: WeakEntity<Self>,
1176 model: Arc<dyn LanguageModel>,
1177 request: LanguageModelRequest,
1178 event_stream: &ThreadEventStream,
1179 tool_use_limit_reached: &mut bool,
1180 refusal: &mut bool,
1181 max_tokens_reached: &mut bool,
1182 cx: &mut AsyncApp,
1183 ) -> Result<FuturesUnordered<Task<LanguageModelToolResult>>> {
1184 log::debug!("Stream completion started successfully");
1185
1186 let mut attempt = None;
1187 'retry: loop {
1188 let mut events = model.stream_completion(request.clone(), cx).await?;
1189 let mut tool_uses = FuturesUnordered::new();
1190 while let Some(event) = events.next().await {
1191 match event {
1192 Ok(LanguageModelCompletionEvent::StatusUpdate(
1193 CompletionRequestStatus::ToolUseLimitReached,
1194 )) => {
1195 *tool_use_limit_reached = true;
1196 }
1197 Ok(LanguageModelCompletionEvent::StatusUpdate(
1198 CompletionRequestStatus::UsageUpdated { amount, limit },
1199 )) => {
1200 this.update(cx, |this, cx| {
1201 this.update_model_request_usage(amount, limit, cx)
1202 })?;
1203 }
1204 Ok(LanguageModelCompletionEvent::UsageUpdate(token_usage)) => {
1205 this.update(cx, |this, cx| this.update_token_usage(token_usage, cx))?;
1206 }
1207 Ok(LanguageModelCompletionEvent::Stop(StopReason::Refusal)) => {
1208 *refusal = true;
1209 return Ok(FuturesUnordered::default());
1210 }
1211 Ok(LanguageModelCompletionEvent::Stop(StopReason::MaxTokens)) => {
1212 *max_tokens_reached = true;
1213 return Ok(FuturesUnordered::default());
1214 }
1215 Ok(LanguageModelCompletionEvent::Stop(
1216 StopReason::ToolUse | StopReason::EndTurn,
1217 )) => break,
1218 Ok(event) => {
1219 log::trace!("Received completion event: {:?}", event);
1220 this.update(cx, |this, cx| {
1221 tool_uses.extend(this.handle_streamed_completion_event(
1222 event,
1223 event_stream,
1224 cx,
1225 ));
1226 })?;
1227 }
1228 Err(error) => {
1229 let completion_mode =
1230 this.read_with(cx, |thread, _cx| thread.completion_mode())?;
1231 if completion_mode == CompletionMode::Normal {
1232 return Err(error.into());
1233 }
1234
1235 let Some(strategy) = Self::retry_strategy_for(&error) else {
1236 return Err(error.into());
1237 };
1238
1239 let max_attempts = match &strategy {
1240 RetryStrategy::ExponentialBackoff { max_attempts, .. } => *max_attempts,
1241 RetryStrategy::Fixed { max_attempts, .. } => *max_attempts,
1242 };
1243
1244 let attempt = attempt.get_or_insert(0u8);
1245
1246 *attempt += 1;
1247
1248 let attempt = *attempt;
1249 if attempt > max_attempts {
1250 return Err(error.into());
1251 }
1252
1253 let delay = match &strategy {
1254 RetryStrategy::ExponentialBackoff { initial_delay, .. } => {
1255 let delay_secs =
1256 initial_delay.as_secs() * 2u64.pow((attempt - 1) as u32);
1257 Duration::from_secs(delay_secs)
1258 }
1259 RetryStrategy::Fixed { delay, .. } => *delay,
1260 };
1261 log::debug!("Retry attempt {attempt} with delay {delay:?}");
1262
1263 event_stream.send_retry(acp_thread::RetryStatus {
1264 last_error: error.to_string().into(),
1265 attempt: attempt as usize,
1266 max_attempts: max_attempts as usize,
1267 started_at: Instant::now(),
1268 duration: delay,
1269 });
1270
1271 cx.background_executor().timer(delay).await;
1272 continue 'retry;
1273 }
1274 }
1275 }
1276
1277 return Ok(tool_uses);
1278 }
1279 }
1280
1281 pub fn build_system_message(&self, cx: &App) -> LanguageModelRequestMessage {
1282 log::debug!("Building system message");
1283 let prompt = SystemPromptTemplate {
1284 project: self.project_context.read(cx),
1285 available_tools: self.tools.keys().cloned().collect(),
1286 }
1287 .render(&self.templates)
1288 .context("failed to build system prompt")
1289 .expect("Invalid template");
1290 log::debug!("System message built");
1291 LanguageModelRequestMessage {
1292 role: Role::System,
1293 content: vec![prompt.into()],
1294 cache: true,
1295 }
1296 }
1297
1298 /// A helper method that's called on every streamed completion event.
1299 /// Returns an optional tool result task, which the main agentic loop in
1300 /// send will send back to the model when it resolves.
1301 fn handle_streamed_completion_event(
1302 &mut self,
1303 event: LanguageModelCompletionEvent,
1304 event_stream: &ThreadEventStream,
1305 cx: &mut Context<Self>,
1306 ) -> Option<Task<LanguageModelToolResult>> {
1307 log::trace!("Handling streamed completion event: {:?}", event);
1308 use LanguageModelCompletionEvent::*;
1309
1310 match event {
1311 StartMessage { .. } => {
1312 self.flush_pending_message(cx);
1313 self.pending_message = Some(AgentMessage::default());
1314 }
1315 Text(new_text) => self.handle_text_event(new_text, event_stream, cx),
1316 Thinking { text, signature } => {
1317 self.handle_thinking_event(text, signature, event_stream, cx)
1318 }
1319 RedactedThinking { data } => self.handle_redacted_thinking_event(data, cx),
1320 ToolUse(tool_use) => {
1321 return self.handle_tool_use_event(tool_use, event_stream, cx);
1322 }
1323 ToolUseJsonParseError {
1324 id,
1325 tool_name,
1326 raw_input,
1327 json_parse_error,
1328 } => {
1329 return Some(Task::ready(self.handle_tool_use_json_parse_error_event(
1330 id,
1331 tool_name,
1332 raw_input,
1333 json_parse_error,
1334 )));
1335 }
1336 StatusUpdate(_) => {}
1337 UsageUpdate(_) | Stop(_) => unreachable!(),
1338 }
1339
1340 None
1341 }
1342
1343 fn handle_text_event(
1344 &mut self,
1345 new_text: String,
1346 event_stream: &ThreadEventStream,
1347 cx: &mut Context<Self>,
1348 ) {
1349 event_stream.send_text(&new_text);
1350
1351 let last_message = self.pending_message();
1352 if let Some(AgentMessageContent::Text(text)) = last_message.content.last_mut() {
1353 text.push_str(&new_text);
1354 } else {
1355 last_message
1356 .content
1357 .push(AgentMessageContent::Text(new_text));
1358 }
1359
1360 cx.notify();
1361 }
1362
1363 fn handle_thinking_event(
1364 &mut self,
1365 new_text: String,
1366 new_signature: Option<String>,
1367 event_stream: &ThreadEventStream,
1368 cx: &mut Context<Self>,
1369 ) {
1370 event_stream.send_thinking(&new_text);
1371
1372 let last_message = self.pending_message();
1373 if let Some(AgentMessageContent::Thinking { text, signature }) =
1374 last_message.content.last_mut()
1375 {
1376 text.push_str(&new_text);
1377 *signature = new_signature.or(signature.take());
1378 } else {
1379 last_message.content.push(AgentMessageContent::Thinking {
1380 text: new_text,
1381 signature: new_signature,
1382 });
1383 }
1384
1385 cx.notify();
1386 }
1387
1388 fn handle_redacted_thinking_event(&mut self, data: String, cx: &mut Context<Self>) {
1389 let last_message = self.pending_message();
1390 last_message
1391 .content
1392 .push(AgentMessageContent::RedactedThinking(data));
1393 cx.notify();
1394 }
1395
1396 fn handle_tool_use_event(
1397 &mut self,
1398 tool_use: LanguageModelToolUse,
1399 event_stream: &ThreadEventStream,
1400 cx: &mut Context<Self>,
1401 ) -> Option<Task<LanguageModelToolResult>> {
1402 cx.notify();
1403
1404 let tool = self.tools.get(tool_use.name.as_ref()).cloned();
1405 let mut title = SharedString::from(&tool_use.name);
1406 let mut kind = acp::ToolKind::Other;
1407 if let Some(tool) = tool.as_ref() {
1408 title = tool.initial_title(tool_use.input.clone());
1409 kind = tool.kind();
1410 }
1411
1412 // Ensure the last message ends in the current tool use
1413 let last_message = self.pending_message();
1414 let push_new_tool_use = last_message.content.last_mut().is_none_or(|content| {
1415 if let AgentMessageContent::ToolUse(last_tool_use) = content {
1416 if last_tool_use.id == tool_use.id {
1417 *last_tool_use = tool_use.clone();
1418 false
1419 } else {
1420 true
1421 }
1422 } else {
1423 true
1424 }
1425 });
1426
1427 if push_new_tool_use {
1428 event_stream.send_tool_call(&tool_use.id, title, kind, tool_use.input.clone());
1429 last_message
1430 .content
1431 .push(AgentMessageContent::ToolUse(tool_use.clone()));
1432 } else {
1433 event_stream.update_tool_call_fields(
1434 &tool_use.id,
1435 acp::ToolCallUpdateFields {
1436 title: Some(title.into()),
1437 kind: Some(kind),
1438 raw_input: Some(tool_use.input.clone()),
1439 ..Default::default()
1440 },
1441 );
1442 }
1443
1444 if !tool_use.is_input_complete {
1445 return None;
1446 }
1447
1448 let Some(tool) = tool else {
1449 let content = format!("No tool named {} exists", tool_use.name);
1450 return Some(Task::ready(LanguageModelToolResult {
1451 content: LanguageModelToolResultContent::Text(Arc::from(content)),
1452 tool_use_id: tool_use.id,
1453 tool_name: tool_use.name,
1454 is_error: true,
1455 output: None,
1456 }));
1457 };
1458
1459 let fs = self.project.read(cx).fs().clone();
1460 let tool_event_stream =
1461 ToolCallEventStream::new(tool_use.id.clone(), event_stream.clone(), Some(fs));
1462 tool_event_stream.update_fields(acp::ToolCallUpdateFields {
1463 status: Some(acp::ToolCallStatus::InProgress),
1464 ..Default::default()
1465 });
1466 let supports_images = self.model().is_some_and(|model| model.supports_images());
1467 let tool_result = tool.run(tool_use.input, tool_event_stream, cx);
1468 log::info!("Running tool {}", tool_use.name);
1469 Some(cx.foreground_executor().spawn(async move {
1470 let tool_result = tool_result.await.and_then(|output| {
1471 if let LanguageModelToolResultContent::Image(_) = &output.llm_output
1472 && !supports_images
1473 {
1474 return Err(anyhow!(
1475 "Attempted to read an image, but this model doesn't support it.",
1476 ));
1477 }
1478 Ok(output)
1479 });
1480
1481 match tool_result {
1482 Ok(output) => LanguageModelToolResult {
1483 tool_use_id: tool_use.id,
1484 tool_name: tool_use.name,
1485 is_error: false,
1486 content: output.llm_output,
1487 output: Some(output.raw_output),
1488 },
1489 Err(error) => LanguageModelToolResult {
1490 tool_use_id: tool_use.id,
1491 tool_name: tool_use.name,
1492 is_error: true,
1493 content: LanguageModelToolResultContent::Text(Arc::from(error.to_string())),
1494 output: None,
1495 },
1496 }
1497 }))
1498 }
1499
1500 fn handle_tool_use_json_parse_error_event(
1501 &mut self,
1502 tool_use_id: LanguageModelToolUseId,
1503 tool_name: Arc<str>,
1504 raw_input: Arc<str>,
1505 json_parse_error: String,
1506 ) -> LanguageModelToolResult {
1507 let tool_output = format!("Error parsing input JSON: {json_parse_error}");
1508 LanguageModelToolResult {
1509 tool_use_id,
1510 tool_name,
1511 is_error: true,
1512 content: LanguageModelToolResultContent::Text(tool_output.into()),
1513 output: Some(serde_json::Value::String(raw_input.to_string())),
1514 }
1515 }
1516
1517 fn update_model_request_usage(&self, amount: usize, limit: UsageLimit, cx: &mut Context<Self>) {
1518 self.project
1519 .read(cx)
1520 .user_store()
1521 .update(cx, |user_store, cx| {
1522 user_store.update_model_request_usage(
1523 ModelRequestUsage(RequestUsage {
1524 amount: amount as i32,
1525 limit,
1526 }),
1527 cx,
1528 )
1529 });
1530 }
1531
1532 pub fn title(&self) -> SharedString {
1533 self.title.clone().unwrap_or("New Thread".into())
1534 }
1535
1536 pub fn summary(&mut self, cx: &mut Context<Self>) -> Task<Result<SharedString>> {
1537 if let Some(summary) = self.summary.as_ref() {
1538 return Task::ready(Ok(summary.clone()));
1539 }
1540 let Some(model) = self.summarization_model.clone() else {
1541 return Task::ready(Err(anyhow!("No summarization model available")));
1542 };
1543 let mut request = LanguageModelRequest {
1544 intent: Some(CompletionIntent::ThreadSummarization),
1545 temperature: AgentSettings::temperature_for_model(&model, cx),
1546 ..Default::default()
1547 };
1548
1549 for message in &self.messages {
1550 request.messages.extend(message.to_request());
1551 }
1552
1553 request.messages.push(LanguageModelRequestMessage {
1554 role: Role::User,
1555 content: vec![SUMMARIZE_THREAD_DETAILED_PROMPT.into()],
1556 cache: false,
1557 });
1558 cx.spawn(async move |this, cx| {
1559 let mut summary = String::new();
1560 let mut messages = model.stream_completion(request, cx).await?;
1561 while let Some(event) = messages.next().await {
1562 let event = event?;
1563 let text = match event {
1564 LanguageModelCompletionEvent::Text(text) => text,
1565 LanguageModelCompletionEvent::StatusUpdate(
1566 CompletionRequestStatus::UsageUpdated { .. },
1567 ) => {
1568 // this.update(cx, |thread, cx| {
1569 // thread.update_model_request_usage(amount as u32, limit, cx);
1570 // })?;
1571 // TODO: handle usage update
1572 continue;
1573 }
1574 _ => continue,
1575 };
1576
1577 let mut lines = text.lines();
1578 summary.extend(lines.next());
1579 }
1580
1581 log::info!("Setting summary: {}", summary);
1582 let summary = SharedString::from(summary);
1583
1584 this.update(cx, |this, cx| {
1585 this.summary = Some(summary.clone());
1586 cx.notify()
1587 })?;
1588
1589 Ok(summary)
1590 })
1591 }
1592
1593 fn update_title(
1594 &mut self,
1595 event_stream: &ThreadEventStream,
1596 cx: &mut Context<Self>,
1597 ) -> Option<Task<Result<()>>> {
1598 if self.title.is_some() {
1599 log::debug!("Skipping title generation because we already have one.");
1600 return None;
1601 }
1602
1603 log::info!(
1604 "Generating title with model: {:?}",
1605 self.summarization_model.as_ref().map(|model| model.name())
1606 );
1607 let model = self.summarization_model.clone()?;
1608 let event_stream = event_stream.clone();
1609 let mut request = LanguageModelRequest {
1610 intent: Some(CompletionIntent::ThreadSummarization),
1611 temperature: AgentSettings::temperature_for_model(&model, cx),
1612 ..Default::default()
1613 };
1614
1615 for message in &self.messages {
1616 request.messages.extend(message.to_request());
1617 }
1618
1619 request.messages.push(LanguageModelRequestMessage {
1620 role: Role::User,
1621 content: vec![SUMMARIZE_THREAD_PROMPT.into()],
1622 cache: false,
1623 });
1624 Some(cx.spawn(async move |this, cx| {
1625 let mut title = String::new();
1626 let mut messages = model.stream_completion(request, cx).await?;
1627 while let Some(event) = messages.next().await {
1628 let event = event?;
1629 let text = match event {
1630 LanguageModelCompletionEvent::Text(text) => text,
1631 LanguageModelCompletionEvent::StatusUpdate(
1632 CompletionRequestStatus::UsageUpdated { .. },
1633 ) => {
1634 // this.update(cx, |thread, cx| {
1635 // thread.update_model_request_usage(amount as u32, limit, cx);
1636 // })?;
1637 // TODO: handle usage update
1638 continue;
1639 }
1640 _ => continue,
1641 };
1642
1643 let mut lines = text.lines();
1644 title.extend(lines.next());
1645
1646 // Stop if the LLM generated multiple lines.
1647 if lines.next().is_some() {
1648 break;
1649 }
1650 }
1651
1652 log::info!("Setting title: {}", title);
1653
1654 this.update(cx, |this, cx| {
1655 let title = SharedString::from(title);
1656 event_stream.send_title_update(title.clone());
1657 this.title = Some(title);
1658 cx.notify();
1659 })
1660 }))
1661 }
1662
1663 fn last_user_message(&self) -> Option<&UserMessage> {
1664 self.messages
1665 .iter()
1666 .rev()
1667 .find_map(|message| match message {
1668 Message::User(user_message) => Some(user_message),
1669 Message::Agent(_) => None,
1670 Message::Resume => None,
1671 })
1672 }
1673
1674 fn pending_message(&mut self) -> &mut AgentMessage {
1675 self.pending_message.get_or_insert_default()
1676 }
1677
1678 fn flush_pending_message(&mut self, cx: &mut Context<Self>) {
1679 let Some(mut message) = self.pending_message.take() else {
1680 return;
1681 };
1682
1683 for content in &message.content {
1684 let AgentMessageContent::ToolUse(tool_use) = content else {
1685 continue;
1686 };
1687
1688 if !message.tool_results.contains_key(&tool_use.id) {
1689 message.tool_results.insert(
1690 tool_use.id.clone(),
1691 LanguageModelToolResult {
1692 tool_use_id: tool_use.id.clone(),
1693 tool_name: tool_use.name.clone(),
1694 is_error: true,
1695 content: LanguageModelToolResultContent::Text(TOOL_CANCELED_MESSAGE.into()),
1696 output: None,
1697 },
1698 );
1699 }
1700 }
1701
1702 self.messages.push(Message::Agent(message));
1703 self.updated_at = Utc::now();
1704 self.summary = None;
1705 cx.notify()
1706 }
1707
1708 pub(crate) fn build_completion_request(
1709 &self,
1710 completion_intent: CompletionIntent,
1711 cx: &mut App,
1712 ) -> Result<LanguageModelRequest> {
1713 let model = self.model().context("No language model configured")?;
1714
1715 log::debug!("Building completion request");
1716 log::debug!("Completion intent: {:?}", completion_intent);
1717 log::debug!("Completion mode: {:?}", self.completion_mode);
1718
1719 let messages = self.build_request_messages(cx);
1720 log::info!("Request will include {} messages", messages.len());
1721
1722 let tools = if let Some(tools) = self.tools(cx).log_err() {
1723 tools
1724 .filter_map(|tool| {
1725 let tool_name = tool.name().to_string();
1726 log::trace!("Including tool: {}", tool_name);
1727 Some(LanguageModelRequestTool {
1728 name: tool_name,
1729 description: tool.description().to_string(),
1730 input_schema: tool.input_schema(model.tool_input_format()).log_err()?,
1731 })
1732 })
1733 .collect()
1734 } else {
1735 Vec::new()
1736 };
1737
1738 log::info!("Request includes {} tools", tools.len());
1739
1740 let request = LanguageModelRequest {
1741 thread_id: Some(self.id.to_string()),
1742 prompt_id: Some(self.prompt_id.to_string()),
1743 intent: Some(completion_intent),
1744 mode: Some(self.completion_mode.into()),
1745 messages,
1746 tools,
1747 tool_choice: None,
1748 stop: Vec::new(),
1749 temperature: AgentSettings::temperature_for_model(model, cx),
1750 thinking_allowed: true,
1751 };
1752
1753 log::debug!("Completion request built successfully");
1754 Ok(request)
1755 }
1756
1757 fn tools<'a>(&'a self, cx: &'a App) -> Result<impl Iterator<Item = &'a Arc<dyn AnyAgentTool>>> {
1758 let model = self.model().context("No language model configured")?;
1759
1760 let profile = AgentSettings::get_global(cx)
1761 .profiles
1762 .get(&self.profile_id)
1763 .context("profile not found")?;
1764 let provider_id = model.provider_id();
1765
1766 Ok(self
1767 .tools
1768 .iter()
1769 .filter(move |(_, tool)| tool.supported_provider(&provider_id))
1770 .filter_map(|(tool_name, tool)| {
1771 if profile.is_tool_enabled(tool_name) {
1772 Some(tool)
1773 } else {
1774 None
1775 }
1776 })
1777 .chain(self.context_server_registry.read(cx).servers().flat_map(
1778 |(server_id, tools)| {
1779 tools.iter().filter_map(|(tool_name, tool)| {
1780 if profile.is_context_server_tool_enabled(&server_id.0, tool_name) {
1781 Some(tool)
1782 } else {
1783 None
1784 }
1785 })
1786 },
1787 )))
1788 }
1789
1790 fn build_request_messages(&self, cx: &App) -> Vec<LanguageModelRequestMessage> {
1791 log::trace!(
1792 "Building request messages from {} thread messages",
1793 self.messages.len()
1794 );
1795 let mut messages = vec![self.build_system_message(cx)];
1796 for message in &self.messages {
1797 messages.extend(message.to_request());
1798 }
1799
1800 if let Some(message) = self.pending_message.as_ref() {
1801 messages.extend(message.to_request());
1802 }
1803
1804 if let Some(last_user_message) = messages
1805 .iter_mut()
1806 .rev()
1807 .find(|message| message.role == Role::User)
1808 {
1809 last_user_message.cache = true;
1810 }
1811
1812 messages
1813 }
1814
1815 pub fn to_markdown(&self) -> String {
1816 let mut markdown = String::new();
1817 for (ix, message) in self.messages.iter().enumerate() {
1818 if ix > 0 {
1819 markdown.push('\n');
1820 }
1821 markdown.push_str(&message.to_markdown());
1822 }
1823
1824 if let Some(message) = self.pending_message.as_ref() {
1825 markdown.push('\n');
1826 markdown.push_str(&message.to_markdown());
1827 }
1828
1829 markdown
1830 }
1831
1832 fn advance_prompt_id(&mut self) {
1833 self.prompt_id = PromptId::new();
1834 }
1835
1836 fn retry_strategy_for(error: &LanguageModelCompletionError) -> Option<RetryStrategy> {
1837 use LanguageModelCompletionError::*;
1838 use http_client::StatusCode;
1839
1840 // General strategy here:
1841 // - If retrying won't help (e.g. invalid API key or payload too large), return None so we don't retry at all.
1842 // - If it's a time-based issue (e.g. server overloaded, rate limit exceeded), retry up to 4 times with exponential backoff.
1843 // - If it's an issue that *might* be fixed by retrying (e.g. internal server error), retry up to 3 times.
1844 match error {
1845 HttpResponseError {
1846 status_code: StatusCode::TOO_MANY_REQUESTS,
1847 ..
1848 } => Some(RetryStrategy::ExponentialBackoff {
1849 initial_delay: BASE_RETRY_DELAY,
1850 max_attempts: MAX_RETRY_ATTEMPTS,
1851 }),
1852 ServerOverloaded { retry_after, .. } | RateLimitExceeded { retry_after, .. } => {
1853 Some(RetryStrategy::Fixed {
1854 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
1855 max_attempts: MAX_RETRY_ATTEMPTS,
1856 })
1857 }
1858 UpstreamProviderError {
1859 status,
1860 retry_after,
1861 ..
1862 } => match *status {
1863 StatusCode::TOO_MANY_REQUESTS | StatusCode::SERVICE_UNAVAILABLE => {
1864 Some(RetryStrategy::Fixed {
1865 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
1866 max_attempts: MAX_RETRY_ATTEMPTS,
1867 })
1868 }
1869 StatusCode::INTERNAL_SERVER_ERROR => Some(RetryStrategy::Fixed {
1870 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
1871 // Internal Server Error could be anything, retry up to 3 times.
1872 max_attempts: 3,
1873 }),
1874 status => {
1875 // There is no StatusCode variant for the unofficial HTTP 529 ("The service is overloaded"),
1876 // but we frequently get them in practice. See https://http.dev/529
1877 if status.as_u16() == 529 {
1878 Some(RetryStrategy::Fixed {
1879 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
1880 max_attempts: MAX_RETRY_ATTEMPTS,
1881 })
1882 } else {
1883 Some(RetryStrategy::Fixed {
1884 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
1885 max_attempts: 2,
1886 })
1887 }
1888 }
1889 },
1890 ApiInternalServerError { .. } => Some(RetryStrategy::Fixed {
1891 delay: BASE_RETRY_DELAY,
1892 max_attempts: 3,
1893 }),
1894 ApiReadResponseError { .. }
1895 | HttpSend { .. }
1896 | DeserializeResponse { .. }
1897 | BadRequestFormat { .. } => Some(RetryStrategy::Fixed {
1898 delay: BASE_RETRY_DELAY,
1899 max_attempts: 3,
1900 }),
1901 // Retrying these errors definitely shouldn't help.
1902 HttpResponseError {
1903 status_code:
1904 StatusCode::PAYLOAD_TOO_LARGE | StatusCode::FORBIDDEN | StatusCode::UNAUTHORIZED,
1905 ..
1906 }
1907 | AuthenticationError { .. }
1908 | PermissionError { .. }
1909 | NoApiKey { .. }
1910 | ApiEndpointNotFound { .. }
1911 | PromptTooLarge { .. } => None,
1912 // These errors might be transient, so retry them
1913 SerializeRequest { .. } | BuildRequestBody { .. } => Some(RetryStrategy::Fixed {
1914 delay: BASE_RETRY_DELAY,
1915 max_attempts: 1,
1916 }),
1917 // Retry all other 4xx and 5xx errors once.
1918 HttpResponseError { status_code, .. }
1919 if status_code.is_client_error() || status_code.is_server_error() =>
1920 {
1921 Some(RetryStrategy::Fixed {
1922 delay: BASE_RETRY_DELAY,
1923 max_attempts: 3,
1924 })
1925 }
1926 Other(err)
1927 if err.is::<language_model::PaymentRequiredError>()
1928 || err.is::<language_model::ModelRequestLimitReachedError>() =>
1929 {
1930 // Retrying won't help for Payment Required or Model Request Limit errors (where
1931 // the user must upgrade to usage-based billing to get more requests, or else wait
1932 // for a significant amount of time for the request limit to reset).
1933 None
1934 }
1935 // Conservatively assume that any other errors are non-retryable
1936 HttpResponseError { .. } | Other(..) => Some(RetryStrategy::Fixed {
1937 delay: BASE_RETRY_DELAY,
1938 max_attempts: 2,
1939 }),
1940 }
1941 }
1942}
1943
1944struct RunningTurn {
1945 /// Holds the task that handles agent interaction until the end of the turn.
1946 /// Survives across multiple requests as the model performs tool calls and
1947 /// we run tools, report their results.
1948 _task: Task<()>,
1949 /// The current event stream for the running turn. Used to report a final
1950 /// cancellation event if we cancel the turn.
1951 event_stream: ThreadEventStream,
1952}
1953
1954impl RunningTurn {
1955 fn cancel(self) {
1956 log::debug!("Cancelling in progress turn");
1957 self.event_stream.send_canceled();
1958 }
1959}
1960
1961pub struct TokenUsageUpdated(pub Option<acp_thread::TokenUsage>);
1962
1963impl EventEmitter<TokenUsageUpdated> for Thread {}
1964
1965pub trait AgentTool
1966where
1967 Self: 'static + Sized,
1968{
1969 type Input: for<'de> Deserialize<'de> + Serialize + JsonSchema;
1970 type Output: for<'de> Deserialize<'de> + Serialize + Into<LanguageModelToolResultContent>;
1971
1972 fn name(&self) -> SharedString;
1973
1974 fn description(&self) -> SharedString {
1975 let schema = schemars::schema_for!(Self::Input);
1976 SharedString::new(
1977 schema
1978 .get("description")
1979 .and_then(|description| description.as_str())
1980 .unwrap_or_default(),
1981 )
1982 }
1983
1984 fn kind(&self) -> acp::ToolKind;
1985
1986 /// The initial tool title to display. Can be updated during the tool run.
1987 fn initial_title(&self, input: Result<Self::Input, serde_json::Value>) -> SharedString;
1988
1989 /// Returns the JSON schema that describes the tool's input.
1990 fn input_schema(&self, format: LanguageModelToolSchemaFormat) -> Schema {
1991 crate::tool_schema::root_schema_for::<Self::Input>(format)
1992 }
1993
1994 /// Some tools rely on a provider for the underlying billing or other reasons.
1995 /// Allow the tool to check if they are compatible, or should be filtered out.
1996 fn supported_provider(&self, _provider: &LanguageModelProviderId) -> bool {
1997 true
1998 }
1999
2000 /// Runs the tool with the provided input.
2001 fn run(
2002 self: Arc<Self>,
2003 input: Self::Input,
2004 event_stream: ToolCallEventStream,
2005 cx: &mut App,
2006 ) -> Task<Result<Self::Output>>;
2007
2008 /// Emits events for a previous execution of the tool.
2009 fn replay(
2010 &self,
2011 _input: Self::Input,
2012 _output: Self::Output,
2013 _event_stream: ToolCallEventStream,
2014 _cx: &mut App,
2015 ) -> Result<()> {
2016 Ok(())
2017 }
2018
2019 fn erase(self) -> Arc<dyn AnyAgentTool> {
2020 Arc::new(Erased(Arc::new(self)))
2021 }
2022}
2023
2024pub struct Erased<T>(T);
2025
2026pub struct AgentToolOutput {
2027 pub llm_output: LanguageModelToolResultContent,
2028 pub raw_output: serde_json::Value,
2029}
2030
2031pub trait AnyAgentTool {
2032 fn name(&self) -> SharedString;
2033 fn description(&self) -> SharedString;
2034 fn kind(&self) -> acp::ToolKind;
2035 fn initial_title(&self, input: serde_json::Value) -> SharedString;
2036 fn input_schema(&self, format: LanguageModelToolSchemaFormat) -> Result<serde_json::Value>;
2037 fn supported_provider(&self, _provider: &LanguageModelProviderId) -> bool {
2038 true
2039 }
2040 fn run(
2041 self: Arc<Self>,
2042 input: serde_json::Value,
2043 event_stream: ToolCallEventStream,
2044 cx: &mut App,
2045 ) -> Task<Result<AgentToolOutput>>;
2046 fn replay(
2047 &self,
2048 input: serde_json::Value,
2049 output: serde_json::Value,
2050 event_stream: ToolCallEventStream,
2051 cx: &mut App,
2052 ) -> Result<()>;
2053}
2054
2055impl<T> AnyAgentTool for Erased<Arc<T>>
2056where
2057 T: AgentTool,
2058{
2059 fn name(&self) -> SharedString {
2060 self.0.name()
2061 }
2062
2063 fn description(&self) -> SharedString {
2064 self.0.description()
2065 }
2066
2067 fn kind(&self) -> agent_client_protocol::ToolKind {
2068 self.0.kind()
2069 }
2070
2071 fn initial_title(&self, input: serde_json::Value) -> SharedString {
2072 let parsed_input = serde_json::from_value(input.clone()).map_err(|_| input);
2073 self.0.initial_title(parsed_input)
2074 }
2075
2076 fn input_schema(&self, format: LanguageModelToolSchemaFormat) -> Result<serde_json::Value> {
2077 let mut json = serde_json::to_value(self.0.input_schema(format))?;
2078 adapt_schema_to_format(&mut json, format)?;
2079 Ok(json)
2080 }
2081
2082 fn supported_provider(&self, provider: &LanguageModelProviderId) -> bool {
2083 self.0.supported_provider(provider)
2084 }
2085
2086 fn run(
2087 self: Arc<Self>,
2088 input: serde_json::Value,
2089 event_stream: ToolCallEventStream,
2090 cx: &mut App,
2091 ) -> Task<Result<AgentToolOutput>> {
2092 cx.spawn(async move |cx| {
2093 let input = serde_json::from_value(input)?;
2094 let output = cx
2095 .update(|cx| self.0.clone().run(input, event_stream, cx))?
2096 .await?;
2097 let raw_output = serde_json::to_value(&output)?;
2098 Ok(AgentToolOutput {
2099 llm_output: output.into(),
2100 raw_output,
2101 })
2102 })
2103 }
2104
2105 fn replay(
2106 &self,
2107 input: serde_json::Value,
2108 output: serde_json::Value,
2109 event_stream: ToolCallEventStream,
2110 cx: &mut App,
2111 ) -> Result<()> {
2112 let input = serde_json::from_value(input)?;
2113 let output = serde_json::from_value(output)?;
2114 self.0.replay(input, output, event_stream, cx)
2115 }
2116}
2117
2118#[derive(Clone)]
2119struct ThreadEventStream(mpsc::UnboundedSender<Result<ThreadEvent>>);
2120
2121impl ThreadEventStream {
2122 fn send_title_update(&self, text: SharedString) {
2123 self.0
2124 .unbounded_send(Ok(ThreadEvent::TitleUpdate(text)))
2125 .ok();
2126 }
2127
2128 fn send_user_message(&self, message: &UserMessage) {
2129 self.0
2130 .unbounded_send(Ok(ThreadEvent::UserMessage(message.clone())))
2131 .ok();
2132 }
2133
2134 fn send_text(&self, text: &str) {
2135 self.0
2136 .unbounded_send(Ok(ThreadEvent::AgentText(text.to_string())))
2137 .ok();
2138 }
2139
2140 fn send_thinking(&self, text: &str) {
2141 self.0
2142 .unbounded_send(Ok(ThreadEvent::AgentThinking(text.to_string())))
2143 .ok();
2144 }
2145
2146 fn send_tool_call(
2147 &self,
2148 id: &LanguageModelToolUseId,
2149 title: SharedString,
2150 kind: acp::ToolKind,
2151 input: serde_json::Value,
2152 ) {
2153 self.0
2154 .unbounded_send(Ok(ThreadEvent::ToolCall(Self::initial_tool_call(
2155 id,
2156 title.to_string(),
2157 kind,
2158 input,
2159 ))))
2160 .ok();
2161 }
2162
2163 fn initial_tool_call(
2164 id: &LanguageModelToolUseId,
2165 title: String,
2166 kind: acp::ToolKind,
2167 input: serde_json::Value,
2168 ) -> acp::ToolCall {
2169 acp::ToolCall {
2170 id: acp::ToolCallId(id.to_string().into()),
2171 title,
2172 kind,
2173 status: acp::ToolCallStatus::Pending,
2174 content: vec![],
2175 locations: vec![],
2176 raw_input: Some(input),
2177 raw_output: None,
2178 }
2179 }
2180
2181 fn update_tool_call_fields(
2182 &self,
2183 tool_use_id: &LanguageModelToolUseId,
2184 fields: acp::ToolCallUpdateFields,
2185 ) {
2186 self.0
2187 .unbounded_send(Ok(ThreadEvent::ToolCallUpdate(
2188 acp::ToolCallUpdate {
2189 id: acp::ToolCallId(tool_use_id.to_string().into()),
2190 fields,
2191 }
2192 .into(),
2193 )))
2194 .ok();
2195 }
2196
2197 fn send_retry(&self, status: acp_thread::RetryStatus) {
2198 self.0.unbounded_send(Ok(ThreadEvent::Retry(status))).ok();
2199 }
2200
2201 fn send_stop(&self, reason: StopReason) {
2202 match reason {
2203 StopReason::EndTurn => {
2204 self.0
2205 .unbounded_send(Ok(ThreadEvent::Stop(acp::StopReason::EndTurn)))
2206 .ok();
2207 }
2208 StopReason::MaxTokens => {
2209 self.0
2210 .unbounded_send(Ok(ThreadEvent::Stop(acp::StopReason::MaxTokens)))
2211 .ok();
2212 }
2213 StopReason::Refusal => {
2214 self.0
2215 .unbounded_send(Ok(ThreadEvent::Stop(acp::StopReason::Refusal)))
2216 .ok();
2217 }
2218 StopReason::ToolUse => {}
2219 }
2220 }
2221
2222 fn send_canceled(&self) {
2223 self.0
2224 .unbounded_send(Ok(ThreadEvent::Stop(acp::StopReason::Canceled)))
2225 .ok();
2226 }
2227
2228 fn send_error(&self, error: impl Into<anyhow::Error>) {
2229 self.0.unbounded_send(Err(error.into())).ok();
2230 }
2231}
2232
2233#[derive(Clone)]
2234pub struct ToolCallEventStream {
2235 tool_use_id: LanguageModelToolUseId,
2236 stream: ThreadEventStream,
2237 fs: Option<Arc<dyn Fs>>,
2238}
2239
2240impl ToolCallEventStream {
2241 #[cfg(test)]
2242 pub fn test() -> (Self, ToolCallEventStreamReceiver) {
2243 let (events_tx, events_rx) = mpsc::unbounded::<Result<ThreadEvent>>();
2244
2245 let stream = ToolCallEventStream::new("test_id".into(), ThreadEventStream(events_tx), None);
2246
2247 (stream, ToolCallEventStreamReceiver(events_rx))
2248 }
2249
2250 fn new(
2251 tool_use_id: LanguageModelToolUseId,
2252 stream: ThreadEventStream,
2253 fs: Option<Arc<dyn Fs>>,
2254 ) -> Self {
2255 Self {
2256 tool_use_id,
2257 stream,
2258 fs,
2259 }
2260 }
2261
2262 pub fn update_fields(&self, fields: acp::ToolCallUpdateFields) {
2263 self.stream
2264 .update_tool_call_fields(&self.tool_use_id, fields);
2265 }
2266
2267 pub fn update_diff(&self, diff: Entity<acp_thread::Diff>) {
2268 self.stream
2269 .0
2270 .unbounded_send(Ok(ThreadEvent::ToolCallUpdate(
2271 acp_thread::ToolCallUpdateDiff {
2272 id: acp::ToolCallId(self.tool_use_id.to_string().into()),
2273 diff,
2274 }
2275 .into(),
2276 )))
2277 .ok();
2278 }
2279
2280 pub fn update_terminal(&self, terminal: Entity<acp_thread::Terminal>) {
2281 self.stream
2282 .0
2283 .unbounded_send(Ok(ThreadEvent::ToolCallUpdate(
2284 acp_thread::ToolCallUpdateTerminal {
2285 id: acp::ToolCallId(self.tool_use_id.to_string().into()),
2286 terminal,
2287 }
2288 .into(),
2289 )))
2290 .ok();
2291 }
2292
2293 pub fn authorize(&self, title: impl Into<String>, cx: &mut App) -> Task<Result<()>> {
2294 if agent_settings::AgentSettings::get_global(cx).always_allow_tool_actions {
2295 return Task::ready(Ok(()));
2296 }
2297
2298 let (response_tx, response_rx) = oneshot::channel();
2299 self.stream
2300 .0
2301 .unbounded_send(Ok(ThreadEvent::ToolCallAuthorization(
2302 ToolCallAuthorization {
2303 tool_call: acp::ToolCallUpdate {
2304 id: acp::ToolCallId(self.tool_use_id.to_string().into()),
2305 fields: acp::ToolCallUpdateFields {
2306 title: Some(title.into()),
2307 ..Default::default()
2308 },
2309 },
2310 options: vec![
2311 acp::PermissionOption {
2312 id: acp::PermissionOptionId("always_allow".into()),
2313 name: "Always Allow".into(),
2314 kind: acp::PermissionOptionKind::AllowAlways,
2315 },
2316 acp::PermissionOption {
2317 id: acp::PermissionOptionId("allow".into()),
2318 name: "Allow".into(),
2319 kind: acp::PermissionOptionKind::AllowOnce,
2320 },
2321 acp::PermissionOption {
2322 id: acp::PermissionOptionId("deny".into()),
2323 name: "Deny".into(),
2324 kind: acp::PermissionOptionKind::RejectOnce,
2325 },
2326 ],
2327 response: response_tx,
2328 },
2329 )))
2330 .ok();
2331 let fs = self.fs.clone();
2332 cx.spawn(async move |cx| match response_rx.await?.0.as_ref() {
2333 "always_allow" => {
2334 if let Some(fs) = fs.clone() {
2335 cx.update(|cx| {
2336 update_settings_file::<AgentSettings>(fs, cx, |settings, _| {
2337 settings.set_always_allow_tool_actions(true);
2338 });
2339 })?;
2340 }
2341
2342 Ok(())
2343 }
2344 "allow" => Ok(()),
2345 _ => Err(anyhow!("Permission to run tool denied by user")),
2346 })
2347 }
2348}
2349
2350#[cfg(test)]
2351pub struct ToolCallEventStreamReceiver(mpsc::UnboundedReceiver<Result<ThreadEvent>>);
2352
2353#[cfg(test)]
2354impl ToolCallEventStreamReceiver {
2355 pub async fn expect_authorization(&mut self) -> ToolCallAuthorization {
2356 let event = self.0.next().await;
2357 if let Some(Ok(ThreadEvent::ToolCallAuthorization(auth))) = event {
2358 auth
2359 } else {
2360 panic!("Expected ToolCallAuthorization but got: {:?}", event);
2361 }
2362 }
2363
2364 pub async fn expect_terminal(&mut self) -> Entity<acp_thread::Terminal> {
2365 let event = self.0.next().await;
2366 if let Some(Ok(ThreadEvent::ToolCallUpdate(acp_thread::ToolCallUpdate::UpdateTerminal(
2367 update,
2368 )))) = event
2369 {
2370 update.terminal
2371 } else {
2372 panic!("Expected terminal but got: {:?}", event);
2373 }
2374 }
2375}
2376
2377#[cfg(test)]
2378impl std::ops::Deref for ToolCallEventStreamReceiver {
2379 type Target = mpsc::UnboundedReceiver<Result<ThreadEvent>>;
2380
2381 fn deref(&self) -> &Self::Target {
2382 &self.0
2383 }
2384}
2385
2386#[cfg(test)]
2387impl std::ops::DerefMut for ToolCallEventStreamReceiver {
2388 fn deref_mut(&mut self) -> &mut Self::Target {
2389 &mut self.0
2390 }
2391}
2392
2393impl From<&str> for UserMessageContent {
2394 fn from(text: &str) -> Self {
2395 Self::Text(text.into())
2396 }
2397}
2398
2399impl From<acp::ContentBlock> for UserMessageContent {
2400 fn from(value: acp::ContentBlock) -> Self {
2401 match value {
2402 acp::ContentBlock::Text(text_content) => Self::Text(text_content.text),
2403 acp::ContentBlock::Image(image_content) => Self::Image(convert_image(image_content)),
2404 acp::ContentBlock::Audio(_) => {
2405 // TODO
2406 Self::Text("[audio]".to_string())
2407 }
2408 acp::ContentBlock::ResourceLink(resource_link) => {
2409 match MentionUri::parse(&resource_link.uri) {
2410 Ok(uri) => Self::Mention {
2411 uri,
2412 content: String::new(),
2413 },
2414 Err(err) => {
2415 log::error!("Failed to parse mention link: {}", err);
2416 Self::Text(format!("[{}]({})", resource_link.name, resource_link.uri))
2417 }
2418 }
2419 }
2420 acp::ContentBlock::Resource(resource) => match resource.resource {
2421 acp::EmbeddedResourceResource::TextResourceContents(resource) => {
2422 match MentionUri::parse(&resource.uri) {
2423 Ok(uri) => Self::Mention {
2424 uri,
2425 content: resource.text,
2426 },
2427 Err(err) => {
2428 log::error!("Failed to parse mention link: {}", err);
2429 Self::Text(
2430 MarkdownCodeBlock {
2431 tag: &resource.uri,
2432 text: &resource.text,
2433 }
2434 .to_string(),
2435 )
2436 }
2437 }
2438 }
2439 acp::EmbeddedResourceResource::BlobResourceContents(_) => {
2440 // TODO
2441 Self::Text("[blob]".to_string())
2442 }
2443 },
2444 }
2445 }
2446}
2447
2448impl From<UserMessageContent> for acp::ContentBlock {
2449 fn from(content: UserMessageContent) -> Self {
2450 match content {
2451 UserMessageContent::Text(text) => acp::ContentBlock::Text(acp::TextContent {
2452 text,
2453 annotations: None,
2454 }),
2455 UserMessageContent::Image(image) => acp::ContentBlock::Image(acp::ImageContent {
2456 data: image.source.to_string(),
2457 mime_type: "image/png".to_string(),
2458 annotations: None,
2459 uri: None,
2460 }),
2461 UserMessageContent::Mention { uri, content } => {
2462 acp::ContentBlock::ResourceLink(acp::ResourceLink {
2463 uri: uri.to_uri().to_string(),
2464 name: uri.name(),
2465 annotations: None,
2466 description: if content.is_empty() {
2467 None
2468 } else {
2469 Some(content)
2470 },
2471 mime_type: None,
2472 size: None,
2473 title: None,
2474 })
2475 }
2476 }
2477 }
2478}
2479
2480fn convert_image(image_content: acp::ImageContent) -> LanguageModelImage {
2481 LanguageModelImage {
2482 source: image_content.data.into(),
2483 // TODO: make this optional?
2484 size: gpui::Size::new(0.into(), 0.into()),
2485 }
2486}