1use crate::{
2 ContextServerRegistry, CopyPathTool, CreateDirectoryTool, DbLanguageModel, DbThread,
3 DeletePathTool, DiagnosticsTool, EditFileTool, FetchTool, FindPathTool, GrepTool,
4 ListDirectoryTool, MovePathTool, NowTool, OpenTool, ProjectSnapshot, ReadFileTool,
5 RestoreFileFromDiskTool, SaveFileTool, SpawnAgentTool, StreamingEditFileTool,
6 SystemPromptTemplate, Template, Templates, TerminalTool, ToolPermissionDecision, WebSearchTool,
7 decide_permission_from_settings,
8};
9use acp_thread::{MentionUri, UserMessageId};
10use action_log::ActionLog;
11use feature_flags::{FeatureFlagAppExt as _, StreamingEditFileToolFeatureFlag};
12
13use agent_client_protocol as acp;
14use agent_settings::{
15 AgentProfileId, AgentProfileSettings, AgentSettings, SUMMARIZE_THREAD_DETAILED_PROMPT,
16 SUMMARIZE_THREAD_PROMPT,
17};
18use anyhow::{Context as _, Result, anyhow};
19use chrono::{DateTime, Utc};
20use client::UserStore;
21use cloud_api_types::Plan;
22use cloud_llm_client::CompletionIntent;
23use collections::{HashMap, HashSet, IndexMap};
24use fs::Fs;
25use futures::stream;
26use futures::{
27 FutureExt,
28 channel::{mpsc, oneshot},
29 future::Shared,
30 stream::FuturesUnordered,
31};
32use gpui::{
33 App, AppContext, AsyncApp, Context, Entity, EventEmitter, SharedString, Task, WeakEntity,
34};
35use heck::ToSnakeCase as _;
36use language_model::{
37 LanguageModel, LanguageModelCompletionError, LanguageModelCompletionEvent, LanguageModelId,
38 LanguageModelImage, LanguageModelProviderId, LanguageModelRegistry, LanguageModelRequest,
39 LanguageModelRequestMessage, LanguageModelRequestTool, LanguageModelToolResult,
40 LanguageModelToolResultContent, LanguageModelToolSchemaFormat, LanguageModelToolUse,
41 LanguageModelToolUseId, Role, SelectedModel, Speed, StopReason, TokenUsage,
42 ZED_CLOUD_PROVIDER_ID,
43};
44use project::Project;
45use prompt_store::ProjectContext;
46use schemars::{JsonSchema, Schema};
47use serde::de::DeserializeOwned;
48use serde::{Deserialize, Serialize};
49use settings::{LanguageModelSelection, Settings, ToolPermissionMode, update_settings_file};
50use smol::stream::StreamExt;
51use std::{
52 collections::BTreeMap,
53 marker::PhantomData,
54 ops::RangeInclusive,
55 path::Path,
56 rc::Rc,
57 sync::Arc,
58 time::{Duration, Instant},
59};
60use std::{fmt::Write, path::PathBuf};
61use util::{ResultExt, debug_panic, markdown::MarkdownCodeBlock, paths::PathStyle};
62use uuid::Uuid;
63
64const TOOL_CANCELED_MESSAGE: &str = "Tool canceled by user";
65pub const MAX_TOOL_NAME_LENGTH: usize = 64;
66pub const MAX_SUBAGENT_DEPTH: u8 = 1;
67
68/// Context passed to a subagent thread for lifecycle management
69#[derive(Clone, Debug, Serialize, Deserialize)]
70pub struct SubagentContext {
71 /// ID of the parent thread
72 pub parent_thread_id: acp::SessionId,
73
74 /// Current depth level (0 = root agent, 1 = first-level subagent, etc.)
75 pub depth: u8,
76}
77
78/// The ID of the user prompt that initiated a request.
79///
80/// This equates to the user physically submitting a message to the model (e.g., by pressing the Enter key).
81#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Serialize, Deserialize)]
82pub struct PromptId(Arc<str>);
83
84impl PromptId {
85 pub fn new() -> Self {
86 Self(Uuid::new_v4().to_string().into())
87 }
88}
89
90impl std::fmt::Display for PromptId {
91 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
92 write!(f, "{}", self.0)
93 }
94}
95
96pub(crate) const MAX_RETRY_ATTEMPTS: u8 = 4;
97pub(crate) const BASE_RETRY_DELAY: Duration = Duration::from_secs(5);
98
99#[derive(Debug, Clone)]
100enum RetryStrategy {
101 ExponentialBackoff {
102 initial_delay: Duration,
103 max_attempts: u8,
104 },
105 Fixed {
106 delay: Duration,
107 max_attempts: u8,
108 },
109}
110
111#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
112pub enum Message {
113 User(UserMessage),
114 Agent(AgentMessage),
115 Resume,
116}
117
118impl Message {
119 pub fn as_agent_message(&self) -> Option<&AgentMessage> {
120 match self {
121 Message::Agent(agent_message) => Some(agent_message),
122 _ => None,
123 }
124 }
125
126 pub fn to_request(&self) -> Vec<LanguageModelRequestMessage> {
127 match self {
128 Message::User(message) => {
129 if message.content.is_empty() {
130 vec![]
131 } else {
132 vec![message.to_request()]
133 }
134 }
135 Message::Agent(message) => message.to_request(),
136 Message::Resume => vec![LanguageModelRequestMessage {
137 role: Role::User,
138 content: vec!["Continue where you left off".into()],
139 cache: false,
140 reasoning_details: None,
141 }],
142 }
143 }
144
145 pub fn to_markdown(&self) -> String {
146 match self {
147 Message::User(message) => message.to_markdown(),
148 Message::Agent(message) => message.to_markdown(),
149 Message::Resume => "[resume]\n".into(),
150 }
151 }
152
153 pub fn role(&self) -> Role {
154 match self {
155 Message::User(_) | Message::Resume => Role::User,
156 Message::Agent(_) => Role::Assistant,
157 }
158 }
159}
160
161#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
162pub struct UserMessage {
163 pub id: UserMessageId,
164 pub content: Vec<UserMessageContent>,
165}
166
167#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
168pub enum UserMessageContent {
169 Text(String),
170 Mention { uri: MentionUri, content: String },
171 Image(LanguageModelImage),
172}
173
174impl UserMessage {
175 pub fn to_markdown(&self) -> String {
176 let mut markdown = String::new();
177
178 for content in &self.content {
179 match content {
180 UserMessageContent::Text(text) => {
181 markdown.push_str(text);
182 markdown.push('\n');
183 }
184 UserMessageContent::Image(_) => {
185 markdown.push_str("<image />\n");
186 }
187 UserMessageContent::Mention { uri, content } => {
188 if !content.is_empty() {
189 let _ = writeln!(&mut markdown, "{}\n\n{}", uri.as_link(), content);
190 } else {
191 let _ = writeln!(&mut markdown, "{}", uri.as_link());
192 }
193 }
194 }
195 }
196
197 markdown
198 }
199
200 fn to_request(&self) -> LanguageModelRequestMessage {
201 let mut message = LanguageModelRequestMessage {
202 role: Role::User,
203 content: Vec::with_capacity(self.content.len()),
204 cache: false,
205 reasoning_details: None,
206 };
207
208 const OPEN_CONTEXT: &str = "<context>\n\
209 The following items were attached by the user. \
210 They are up-to-date and don't need to be re-read.\n\n";
211
212 const OPEN_FILES_TAG: &str = "<files>";
213 const OPEN_DIRECTORIES_TAG: &str = "<directories>";
214 const OPEN_SYMBOLS_TAG: &str = "<symbols>";
215 const OPEN_SELECTIONS_TAG: &str = "<selections>";
216 const OPEN_THREADS_TAG: &str = "<threads>";
217 const OPEN_FETCH_TAG: &str = "<fetched_urls>";
218 const OPEN_RULES_TAG: &str =
219 "<rules>\nThe user has specified the following rules that should be applied:\n";
220 const OPEN_DIAGNOSTICS_TAG: &str = "<diagnostics>";
221 const OPEN_DIFFS_TAG: &str = "<diffs>";
222
223 let mut file_context = OPEN_FILES_TAG.to_string();
224 let mut directory_context = OPEN_DIRECTORIES_TAG.to_string();
225 let mut symbol_context = OPEN_SYMBOLS_TAG.to_string();
226 let mut selection_context = OPEN_SELECTIONS_TAG.to_string();
227 let mut thread_context = OPEN_THREADS_TAG.to_string();
228 let mut fetch_context = OPEN_FETCH_TAG.to_string();
229 let mut rules_context = OPEN_RULES_TAG.to_string();
230 let mut diagnostics_context = OPEN_DIAGNOSTICS_TAG.to_string();
231 let mut diffs_context = OPEN_DIFFS_TAG.to_string();
232
233 for chunk in &self.content {
234 let chunk = match chunk {
235 UserMessageContent::Text(text) => {
236 language_model::MessageContent::Text(text.clone())
237 }
238 UserMessageContent::Image(value) => {
239 language_model::MessageContent::Image(value.clone())
240 }
241 UserMessageContent::Mention { uri, content } => {
242 match uri {
243 MentionUri::File { abs_path } => {
244 write!(
245 &mut file_context,
246 "\n{}",
247 MarkdownCodeBlock {
248 tag: &codeblock_tag(abs_path, None),
249 text: &content.to_string(),
250 }
251 )
252 .ok();
253 }
254 MentionUri::PastedImage => {
255 debug_panic!("pasted image URI should not be used in mention content")
256 }
257 MentionUri::Directory { .. } => {
258 write!(&mut directory_context, "\n{}\n", content).ok();
259 }
260 MentionUri::Symbol {
261 abs_path: path,
262 line_range,
263 ..
264 } => {
265 write!(
266 &mut symbol_context,
267 "\n{}",
268 MarkdownCodeBlock {
269 tag: &codeblock_tag(path, Some(line_range)),
270 text: content
271 }
272 )
273 .ok();
274 }
275 MentionUri::Selection {
276 abs_path: path,
277 line_range,
278 ..
279 } => {
280 write!(
281 &mut selection_context,
282 "\n{}",
283 MarkdownCodeBlock {
284 tag: &codeblock_tag(
285 path.as_deref().unwrap_or("Untitled".as_ref()),
286 Some(line_range)
287 ),
288 text: content
289 }
290 )
291 .ok();
292 }
293 MentionUri::Thread { .. } => {
294 write!(&mut thread_context, "\n{}\n", content).ok();
295 }
296 MentionUri::TextThread { .. } => {
297 write!(&mut thread_context, "\n{}\n", content).ok();
298 }
299 MentionUri::Rule { .. } => {
300 write!(
301 &mut rules_context,
302 "\n{}",
303 MarkdownCodeBlock {
304 tag: "",
305 text: content
306 }
307 )
308 .ok();
309 }
310 MentionUri::Fetch { url } => {
311 write!(&mut fetch_context, "\nFetch: {}\n\n{}", url, content).ok();
312 }
313 MentionUri::Diagnostics { .. } => {
314 write!(&mut diagnostics_context, "\n{}\n", content).ok();
315 }
316 MentionUri::TerminalSelection { .. } => {
317 write!(
318 &mut selection_context,
319 "\n{}",
320 MarkdownCodeBlock {
321 tag: "console",
322 text: content
323 }
324 )
325 .ok();
326 }
327 MentionUri::GitDiff { base_ref } => {
328 write!(
329 &mut diffs_context,
330 "\nBranch diff against {}:\n{}",
331 base_ref,
332 MarkdownCodeBlock {
333 tag: "diff",
334 text: content
335 }
336 )
337 .ok();
338 }
339 }
340
341 language_model::MessageContent::Text(uri.as_link().to_string())
342 }
343 };
344
345 message.content.push(chunk);
346 }
347
348 let len_before_context = message.content.len();
349
350 if file_context.len() > OPEN_FILES_TAG.len() {
351 file_context.push_str("</files>\n");
352 message
353 .content
354 .push(language_model::MessageContent::Text(file_context));
355 }
356
357 if directory_context.len() > OPEN_DIRECTORIES_TAG.len() {
358 directory_context.push_str("</directories>\n");
359 message
360 .content
361 .push(language_model::MessageContent::Text(directory_context));
362 }
363
364 if symbol_context.len() > OPEN_SYMBOLS_TAG.len() {
365 symbol_context.push_str("</symbols>\n");
366 message
367 .content
368 .push(language_model::MessageContent::Text(symbol_context));
369 }
370
371 if selection_context.len() > OPEN_SELECTIONS_TAG.len() {
372 selection_context.push_str("</selections>\n");
373 message
374 .content
375 .push(language_model::MessageContent::Text(selection_context));
376 }
377
378 if diffs_context.len() > OPEN_DIFFS_TAG.len() {
379 diffs_context.push_str("</diffs>\n");
380 message
381 .content
382 .push(language_model::MessageContent::Text(diffs_context));
383 }
384
385 if thread_context.len() > OPEN_THREADS_TAG.len() {
386 thread_context.push_str("</threads>\n");
387 message
388 .content
389 .push(language_model::MessageContent::Text(thread_context));
390 }
391
392 if fetch_context.len() > OPEN_FETCH_TAG.len() {
393 fetch_context.push_str("</fetched_urls>\n");
394 message
395 .content
396 .push(language_model::MessageContent::Text(fetch_context));
397 }
398
399 if rules_context.len() > OPEN_RULES_TAG.len() {
400 rules_context.push_str("</user_rules>\n");
401 message
402 .content
403 .push(language_model::MessageContent::Text(rules_context));
404 }
405
406 if diagnostics_context.len() > OPEN_DIAGNOSTICS_TAG.len() {
407 diagnostics_context.push_str("</diagnostics>\n");
408 message
409 .content
410 .push(language_model::MessageContent::Text(diagnostics_context));
411 }
412
413 if message.content.len() > len_before_context {
414 message.content.insert(
415 len_before_context,
416 language_model::MessageContent::Text(OPEN_CONTEXT.into()),
417 );
418 message
419 .content
420 .push(language_model::MessageContent::Text("</context>".into()));
421 }
422
423 message
424 }
425}
426
427fn codeblock_tag(full_path: &Path, line_range: Option<&RangeInclusive<u32>>) -> String {
428 let mut result = String::new();
429
430 if let Some(extension) = full_path.extension().and_then(|ext| ext.to_str()) {
431 let _ = write!(result, "{} ", extension);
432 }
433
434 let _ = write!(result, "{}", full_path.display());
435
436 if let Some(range) = line_range {
437 if range.start() == range.end() {
438 let _ = write!(result, ":{}", range.start() + 1);
439 } else {
440 let _ = write!(result, ":{}-{}", range.start() + 1, range.end() + 1);
441 }
442 }
443
444 result
445}
446
447impl AgentMessage {
448 pub fn to_markdown(&self) -> String {
449 let mut markdown = String::new();
450
451 for content in &self.content {
452 match content {
453 AgentMessageContent::Text(text) => {
454 markdown.push_str(text);
455 markdown.push('\n');
456 }
457 AgentMessageContent::Thinking { text, .. } => {
458 markdown.push_str("<think>");
459 markdown.push_str(text);
460 markdown.push_str("</think>\n");
461 }
462 AgentMessageContent::RedactedThinking(_) => {
463 markdown.push_str("<redacted_thinking />\n")
464 }
465 AgentMessageContent::ToolUse(tool_use) => {
466 markdown.push_str(&format!(
467 "**Tool Use**: {} (ID: {})\n",
468 tool_use.name, tool_use.id
469 ));
470 markdown.push_str(&format!(
471 "{}\n",
472 MarkdownCodeBlock {
473 tag: "json",
474 text: &format!("{:#}", tool_use.input)
475 }
476 ));
477 }
478 }
479 }
480
481 for tool_result in self.tool_results.values() {
482 markdown.push_str(&format!(
483 "**Tool Result**: {} (ID: {})\n\n",
484 tool_result.tool_name, tool_result.tool_use_id
485 ));
486 if tool_result.is_error {
487 markdown.push_str("**ERROR:**\n");
488 }
489
490 match &tool_result.content {
491 LanguageModelToolResultContent::Text(text) => {
492 writeln!(markdown, "{text}\n").ok();
493 }
494 LanguageModelToolResultContent::Image(_) => {
495 writeln!(markdown, "<image />\n").ok();
496 }
497 }
498
499 if let Some(output) = tool_result.output.as_ref() {
500 writeln!(
501 markdown,
502 "**Debug Output**:\n\n```json\n{}\n```\n",
503 serde_json::to_string_pretty(output).unwrap()
504 )
505 .unwrap();
506 }
507 }
508
509 markdown
510 }
511
512 pub fn to_request(&self) -> Vec<LanguageModelRequestMessage> {
513 let mut assistant_message = LanguageModelRequestMessage {
514 role: Role::Assistant,
515 content: Vec::with_capacity(self.content.len()),
516 cache: false,
517 reasoning_details: self.reasoning_details.clone(),
518 };
519 for chunk in &self.content {
520 match chunk {
521 AgentMessageContent::Text(text) => {
522 assistant_message
523 .content
524 .push(language_model::MessageContent::Text(text.clone()));
525 }
526 AgentMessageContent::Thinking { text, signature } => {
527 assistant_message
528 .content
529 .push(language_model::MessageContent::Thinking {
530 text: text.clone(),
531 signature: signature.clone(),
532 });
533 }
534 AgentMessageContent::RedactedThinking(value) => {
535 assistant_message.content.push(
536 language_model::MessageContent::RedactedThinking(value.clone()),
537 );
538 }
539 AgentMessageContent::ToolUse(tool_use) => {
540 if self.tool_results.contains_key(&tool_use.id) {
541 assistant_message
542 .content
543 .push(language_model::MessageContent::ToolUse(tool_use.clone()));
544 }
545 }
546 };
547 }
548
549 let mut user_message = LanguageModelRequestMessage {
550 role: Role::User,
551 content: Vec::new(),
552 cache: false,
553 reasoning_details: None,
554 };
555
556 for tool_result in self.tool_results.values() {
557 let mut tool_result = tool_result.clone();
558 // Surprisingly, the API fails if we return an empty string here.
559 // It thinks we are sending a tool use without a tool result.
560 if tool_result.content.is_empty() {
561 tool_result.content = "<Tool returned an empty string>".into();
562 }
563 user_message
564 .content
565 .push(language_model::MessageContent::ToolResult(tool_result));
566 }
567
568 let mut messages = Vec::new();
569 if !assistant_message.content.is_empty() {
570 messages.push(assistant_message);
571 }
572 if !user_message.content.is_empty() {
573 messages.push(user_message);
574 }
575 messages
576 }
577}
578
579#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
580pub struct AgentMessage {
581 pub content: Vec<AgentMessageContent>,
582 pub tool_results: IndexMap<LanguageModelToolUseId, LanguageModelToolResult>,
583 pub reasoning_details: Option<serde_json::Value>,
584}
585
586#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
587pub enum AgentMessageContent {
588 Text(String),
589 Thinking {
590 text: String,
591 signature: Option<String>,
592 },
593 RedactedThinking(String),
594 ToolUse(LanguageModelToolUse),
595}
596
597pub trait TerminalHandle {
598 fn id(&self, cx: &AsyncApp) -> Result<acp::TerminalId>;
599 fn current_output(&self, cx: &AsyncApp) -> Result<acp::TerminalOutputResponse>;
600 fn wait_for_exit(&self, cx: &AsyncApp) -> Result<Shared<Task<acp::TerminalExitStatus>>>;
601 fn kill(&self, cx: &AsyncApp) -> Result<()>;
602 fn was_stopped_by_user(&self, cx: &AsyncApp) -> Result<bool>;
603}
604
605pub trait SubagentHandle {
606 /// The session ID of this subagent thread
607 fn id(&self) -> acp::SessionId;
608 /// The current number of entries in the thread.
609 /// Useful for knowing where the next turn will begin
610 fn num_entries(&self, cx: &App) -> usize;
611 /// Runs a turn for a given message and returns both the response and the index of that output message.
612 fn send(&self, message: String, cx: &AsyncApp) -> Task<Result<String>>;
613}
614
615pub trait ThreadEnvironment {
616 fn create_terminal(
617 &self,
618 command: String,
619 cwd: Option<PathBuf>,
620 output_byte_limit: Option<u64>,
621 cx: &mut AsyncApp,
622 ) -> Task<Result<Rc<dyn TerminalHandle>>>;
623
624 fn create_subagent(&self, label: String, cx: &mut App) -> Result<Rc<dyn SubagentHandle>>;
625
626 fn resume_subagent(
627 &self,
628 _session_id: acp::SessionId,
629 _cx: &mut App,
630 ) -> Result<Rc<dyn SubagentHandle>> {
631 Err(anyhow::anyhow!(
632 "Resuming subagent sessions is not supported"
633 ))
634 }
635}
636
637#[derive(Debug)]
638pub enum ThreadEvent {
639 UserMessage(UserMessage),
640 AgentText(String),
641 AgentThinking(String),
642 ToolCall(acp::ToolCall),
643 ToolCallUpdate(acp_thread::ToolCallUpdate),
644 ToolCallAuthorization(ToolCallAuthorization),
645 SubagentSpawned(acp::SessionId),
646 Retry(acp_thread::RetryStatus),
647 Stop(acp::StopReason),
648}
649
650#[derive(Debug)]
651pub struct NewTerminal {
652 pub command: String,
653 pub output_byte_limit: Option<u64>,
654 pub cwd: Option<PathBuf>,
655 pub response: oneshot::Sender<Result<Entity<acp_thread::Terminal>>>,
656}
657
658#[derive(Debug, Clone)]
659pub struct ToolPermissionContext {
660 pub tool_name: String,
661 pub input_values: Vec<String>,
662 pub scope: ToolPermissionScope,
663}
664
665#[derive(Debug, Clone, Copy, PartialEq, Eq)]
666pub enum ToolPermissionScope {
667 ToolInput,
668 SymlinkTarget,
669}
670
671impl ToolPermissionContext {
672 pub fn new(tool_name: impl Into<String>, input_values: Vec<String>) -> Self {
673 Self {
674 tool_name: tool_name.into(),
675 input_values,
676 scope: ToolPermissionScope::ToolInput,
677 }
678 }
679
680 pub fn symlink_target(tool_name: impl Into<String>, target_paths: Vec<String>) -> Self {
681 Self {
682 tool_name: tool_name.into(),
683 input_values: target_paths,
684 scope: ToolPermissionScope::SymlinkTarget,
685 }
686 }
687
688 /// Builds the permission options for this tool context.
689 ///
690 /// This is the canonical source for permission option generation.
691 /// Tests should use this function rather than manually constructing options.
692 ///
693 /// # Shell Compatibility for Terminal Tool
694 ///
695 /// For the terminal tool, "Always allow" options are only shown when the user's
696 /// shell supports POSIX-like command chaining syntax (`&&`, `||`, `;`, `|`).
697 ///
698 /// **Why this matters:** When a user sets up an "always allow" pattern like `^cargo`,
699 /// we need to parse the command to extract all sub-commands and verify that EVERY
700 /// sub-command matches the pattern. Otherwise, an attacker could craft a command like
701 /// `cargo build && rm -rf /` that would bypass the security check.
702 ///
703 /// **Supported shells:** Posix (sh, bash, dash, zsh), Fish 3.0+, PowerShell 7+/Pwsh,
704 /// Cmd, Xonsh, Csh, Tcsh
705 ///
706 /// **Unsupported shells:** Nushell (uses `and`/`or` keywords), Elvish (uses `and`/`or`
707 /// keywords), Rc (Plan 9 shell - no `&&`/`||` operators)
708 ///
709 /// For unsupported shells, we hide the "Always allow" UI options entirely, and if
710 /// the user has `always_allow` rules configured in settings, `ToolPermissionDecision::from_input`
711 /// will return a `Deny` with an explanatory error message.
712 pub fn build_permission_options(&self) -> acp_thread::PermissionOptions {
713 use crate::pattern_extraction::*;
714 use util::shell::ShellKind;
715
716 let tool_name = &self.tool_name;
717 let input_values = &self.input_values;
718 if self.scope == ToolPermissionScope::SymlinkTarget {
719 return acp_thread::PermissionOptions::Flat(vec![
720 acp::PermissionOption::new(
721 acp::PermissionOptionId::new("allow"),
722 "Yes",
723 acp::PermissionOptionKind::AllowOnce,
724 ),
725 acp::PermissionOption::new(
726 acp::PermissionOptionId::new("deny"),
727 "No",
728 acp::PermissionOptionKind::RejectOnce,
729 ),
730 ]);
731 }
732
733 // Check if the user's shell supports POSIX-like command chaining.
734 // See the doc comment above for the full explanation of why this is needed.
735 let shell_supports_always_allow = if tool_name == TerminalTool::NAME {
736 ShellKind::system().supports_posix_chaining()
737 } else {
738 true
739 };
740
741 let extract_for_value = |value: &str| -> (Option<String>, Option<String>) {
742 if tool_name == TerminalTool::NAME {
743 (
744 extract_terminal_pattern(value),
745 extract_terminal_pattern_display(value),
746 )
747 } else if tool_name == CopyPathTool::NAME
748 || tool_name == MovePathTool::NAME
749 || tool_name == EditFileTool::NAME
750 || tool_name == DeletePathTool::NAME
751 || tool_name == CreateDirectoryTool::NAME
752 || tool_name == SaveFileTool::NAME
753 {
754 (
755 extract_path_pattern(value),
756 extract_path_pattern_display(value),
757 )
758 } else if tool_name == FetchTool::NAME {
759 (
760 extract_url_pattern(value),
761 extract_url_pattern_display(value),
762 )
763 } else {
764 (None, None)
765 }
766 };
767
768 // Extract patterns from all input values. Only offer a pattern-specific
769 // "always allow/deny" button when every value produces the same pattern.
770 let (pattern, pattern_display) = match input_values.as_slice() {
771 [single] => extract_for_value(single),
772 _ => {
773 let mut iter = input_values.iter().map(|v| extract_for_value(v));
774 match iter.next() {
775 Some(first) => {
776 if iter.all(|pair| pair.0 == first.0) {
777 first
778 } else {
779 (None, None)
780 }
781 }
782 None => (None, None),
783 }
784 }
785 };
786
787 let mut choices = Vec::new();
788
789 let mut push_choice = |label: String, allow_id, deny_id, allow_kind, deny_kind| {
790 choices.push(acp_thread::PermissionOptionChoice {
791 allow: acp::PermissionOption::new(
792 acp::PermissionOptionId::new(allow_id),
793 label.clone(),
794 allow_kind,
795 ),
796 deny: acp::PermissionOption::new(
797 acp::PermissionOptionId::new(deny_id),
798 label,
799 deny_kind,
800 ),
801 });
802 };
803
804 if shell_supports_always_allow {
805 push_choice(
806 format!("Always for {}", tool_name.replace('_', " ")),
807 format!("always_allow:{}", tool_name),
808 format!("always_deny:{}", tool_name),
809 acp::PermissionOptionKind::AllowAlways,
810 acp::PermissionOptionKind::RejectAlways,
811 );
812
813 if let (Some(pattern), Some(display)) = (pattern, pattern_display) {
814 let button_text = if tool_name == TerminalTool::NAME {
815 format!("Always for `{}` commands", display)
816 } else {
817 format!("Always for `{}`", display)
818 };
819 push_choice(
820 button_text,
821 format!("always_allow_pattern:{}\n{}", tool_name, pattern),
822 format!("always_deny_pattern:{}\n{}", tool_name, pattern),
823 acp::PermissionOptionKind::AllowAlways,
824 acp::PermissionOptionKind::RejectAlways,
825 );
826 }
827 }
828
829 push_choice(
830 "Only this time".to_string(),
831 "allow".to_string(),
832 "deny".to_string(),
833 acp::PermissionOptionKind::AllowOnce,
834 acp::PermissionOptionKind::RejectOnce,
835 );
836
837 acp_thread::PermissionOptions::Dropdown(choices)
838 }
839}
840
841#[derive(Debug)]
842pub struct ToolCallAuthorization {
843 pub tool_call: acp::ToolCallUpdate,
844 pub options: acp_thread::PermissionOptions,
845 pub response: oneshot::Sender<acp::PermissionOptionId>,
846 pub context: Option<ToolPermissionContext>,
847}
848
849#[derive(Debug, thiserror::Error)]
850enum CompletionError {
851 #[error("max tokens")]
852 MaxTokens,
853 #[error("refusal")]
854 Refusal,
855 #[error(transparent)]
856 Other(#[from] anyhow::Error),
857}
858
859pub struct Thread {
860 id: acp::SessionId,
861 prompt_id: PromptId,
862 updated_at: DateTime<Utc>,
863 title: Option<SharedString>,
864 pending_title_generation: Option<Task<()>>,
865 pending_summary_generation: Option<Shared<Task<Option<SharedString>>>>,
866 summary: Option<SharedString>,
867 messages: Vec<Message>,
868 user_store: Entity<UserStore>,
869 /// Holds the task that handles agent interaction until the end of the turn.
870 /// Survives across multiple requests as the model performs tool calls and
871 /// we run tools, report their results.
872 running_turn: Option<RunningTurn>,
873 /// Flag indicating the UI has a queued message waiting to be sent.
874 /// Used to signal that the turn should end at the next message boundary.
875 has_queued_message: bool,
876 pending_message: Option<AgentMessage>,
877 pub(crate) tools: BTreeMap<SharedString, Arc<dyn AnyAgentTool>>,
878 request_token_usage: HashMap<UserMessageId, language_model::TokenUsage>,
879 #[allow(unused)]
880 cumulative_token_usage: TokenUsage,
881 #[allow(unused)]
882 initial_project_snapshot: Shared<Task<Option<Arc<ProjectSnapshot>>>>,
883 pub(crate) context_server_registry: Entity<ContextServerRegistry>,
884 profile_id: AgentProfileId,
885 project_context: Entity<ProjectContext>,
886 pub(crate) templates: Arc<Templates>,
887 model: Option<Arc<dyn LanguageModel>>,
888 summarization_model: Option<Arc<dyn LanguageModel>>,
889 thinking_enabled: bool,
890 thinking_effort: Option<String>,
891 speed: Option<Speed>,
892 prompt_capabilities_tx: watch::Sender<acp::PromptCapabilities>,
893 pub(crate) prompt_capabilities_rx: watch::Receiver<acp::PromptCapabilities>,
894 pub(crate) project: Entity<Project>,
895 pub(crate) action_log: Entity<ActionLog>,
896 /// Tracks the last time files were read by the agent, to detect external modifications
897 pub(crate) file_read_times: HashMap<PathBuf, fs::MTime>,
898 /// True if this thread was imported from a shared thread and can be synced.
899 imported: bool,
900 /// If this is a subagent thread, contains context about the parent
901 subagent_context: Option<SubagentContext>,
902 /// Weak references to running subagent threads for cancellation propagation
903 running_subagents: Vec<WeakEntity<Thread>>,
904}
905
906impl Thread {
907 fn prompt_capabilities(model: Option<&dyn LanguageModel>) -> acp::PromptCapabilities {
908 let image = model.map_or(true, |model| model.supports_images());
909 acp::PromptCapabilities::new()
910 .image(image)
911 .embedded_context(true)
912 }
913
914 pub fn new_subagent(parent_thread: &Entity<Thread>, cx: &mut Context<Self>) -> Self {
915 let project = parent_thread.read(cx).project.clone();
916 let project_context = parent_thread.read(cx).project_context.clone();
917 let context_server_registry = parent_thread.read(cx).context_server_registry.clone();
918 let templates = parent_thread.read(cx).templates.clone();
919 let model = parent_thread.read(cx).model().cloned();
920 let mut thread = Self::new(
921 project,
922 project_context,
923 context_server_registry,
924 templates,
925 model,
926 cx,
927 );
928 thread.subagent_context = Some(SubagentContext {
929 parent_thread_id: parent_thread.read(cx).id().clone(),
930 depth: parent_thread.read(cx).depth() + 1,
931 });
932 thread
933 }
934
935 pub fn new(
936 project: Entity<Project>,
937 project_context: Entity<ProjectContext>,
938 context_server_registry: Entity<ContextServerRegistry>,
939 templates: Arc<Templates>,
940 model: Option<Arc<dyn LanguageModel>>,
941 cx: &mut Context<Self>,
942 ) -> Self {
943 let settings = AgentSettings::get_global(cx);
944 let profile_id = settings.default_profile.clone();
945 let enable_thinking = settings
946 .default_model
947 .as_ref()
948 .is_some_and(|model| model.enable_thinking);
949 let thinking_effort = settings
950 .default_model
951 .as_ref()
952 .and_then(|model| model.effort.clone());
953 let action_log = cx.new(|_cx| ActionLog::new(project.clone()));
954 let (prompt_capabilities_tx, prompt_capabilities_rx) =
955 watch::channel(Self::prompt_capabilities(model.as_deref()));
956 Self {
957 id: acp::SessionId::new(uuid::Uuid::new_v4().to_string()),
958 prompt_id: PromptId::new(),
959 updated_at: Utc::now(),
960 title: None,
961 pending_title_generation: None,
962 pending_summary_generation: None,
963 summary: None,
964 messages: Vec::new(),
965 user_store: project.read(cx).user_store(),
966 running_turn: None,
967 has_queued_message: false,
968 pending_message: None,
969 tools: BTreeMap::default(),
970 request_token_usage: HashMap::default(),
971 cumulative_token_usage: TokenUsage::default(),
972 initial_project_snapshot: {
973 let project_snapshot = Self::project_snapshot(project.clone(), cx);
974 cx.foreground_executor()
975 .spawn(async move { Some(project_snapshot.await) })
976 .shared()
977 },
978 context_server_registry,
979 profile_id,
980 project_context,
981 templates,
982 model,
983 summarization_model: None,
984 thinking_enabled: enable_thinking,
985 speed: None,
986 thinking_effort,
987 prompt_capabilities_tx,
988 prompt_capabilities_rx,
989 project,
990 action_log,
991 file_read_times: HashMap::default(),
992 imported: false,
993 subagent_context: None,
994 running_subagents: Vec::new(),
995 }
996 }
997
998 pub fn id(&self) -> &acp::SessionId {
999 &self.id
1000 }
1001
1002 /// Returns true if this thread was imported from a shared thread.
1003 pub fn is_imported(&self) -> bool {
1004 self.imported
1005 }
1006
1007 pub fn replay(
1008 &mut self,
1009 cx: &mut Context<Self>,
1010 ) -> mpsc::UnboundedReceiver<Result<ThreadEvent>> {
1011 let (tx, rx) = mpsc::unbounded();
1012 let stream = ThreadEventStream(tx);
1013 for message in &self.messages {
1014 match message {
1015 Message::User(user_message) => stream.send_user_message(user_message),
1016 Message::Agent(assistant_message) => {
1017 for content in &assistant_message.content {
1018 match content {
1019 AgentMessageContent::Text(text) => stream.send_text(text),
1020 AgentMessageContent::Thinking { text, .. } => {
1021 stream.send_thinking(text)
1022 }
1023 AgentMessageContent::RedactedThinking(_) => {}
1024 AgentMessageContent::ToolUse(tool_use) => {
1025 self.replay_tool_call(
1026 tool_use,
1027 assistant_message.tool_results.get(&tool_use.id),
1028 &stream,
1029 cx,
1030 );
1031 }
1032 }
1033 }
1034 }
1035 Message::Resume => {}
1036 }
1037 }
1038 rx
1039 }
1040
1041 fn replay_tool_call(
1042 &self,
1043 tool_use: &LanguageModelToolUse,
1044 tool_result: Option<&LanguageModelToolResult>,
1045 stream: &ThreadEventStream,
1046 cx: &mut Context<Self>,
1047 ) {
1048 // Extract saved output and status first, so they're available even if tool is not found
1049 let output = tool_result
1050 .as_ref()
1051 .and_then(|result| result.output.clone());
1052 let status = tool_result
1053 .as_ref()
1054 .map_or(acp::ToolCallStatus::Failed, |result| {
1055 if result.is_error {
1056 acp::ToolCallStatus::Failed
1057 } else {
1058 acp::ToolCallStatus::Completed
1059 }
1060 });
1061
1062 let tool = self.tools.get(tool_use.name.as_ref()).cloned().or_else(|| {
1063 self.context_server_registry
1064 .read(cx)
1065 .servers()
1066 .find_map(|(_, tools)| {
1067 if let Some(tool) = tools.get(tool_use.name.as_ref()) {
1068 Some(tool.clone())
1069 } else {
1070 None
1071 }
1072 })
1073 });
1074
1075 let Some(tool) = tool else {
1076 // Tool not found (e.g., MCP server not connected after restart),
1077 // but still display the saved result if available.
1078 // We need to send both ToolCall and ToolCallUpdate events because the UI
1079 // only converts raw_output to displayable content in update_fields, not from_acp.
1080 stream
1081 .0
1082 .unbounded_send(Ok(ThreadEvent::ToolCall(
1083 acp::ToolCall::new(tool_use.id.to_string(), tool_use.name.to_string())
1084 .status(status)
1085 .raw_input(tool_use.input.clone()),
1086 )))
1087 .ok();
1088 stream.update_tool_call_fields(
1089 &tool_use.id,
1090 acp::ToolCallUpdateFields::new()
1091 .status(status)
1092 .raw_output(output),
1093 None,
1094 );
1095 return;
1096 };
1097
1098 let title = tool.initial_title(tool_use.input.clone(), cx);
1099 let kind = tool.kind();
1100 stream.send_tool_call(
1101 &tool_use.id,
1102 &tool_use.name,
1103 title,
1104 kind,
1105 tool_use.input.clone(),
1106 );
1107
1108 if let Some(output) = output.clone() {
1109 // For replay, we use a dummy cancellation receiver since the tool already completed
1110 let (_cancellation_tx, cancellation_rx) = watch::channel(false);
1111 let tool_event_stream = ToolCallEventStream::new(
1112 tool_use.id.clone(),
1113 stream.clone(),
1114 Some(self.project.read(cx).fs().clone()),
1115 cancellation_rx,
1116 );
1117 tool.replay(tool_use.input.clone(), output, tool_event_stream, cx)
1118 .log_err();
1119 }
1120
1121 stream.update_tool_call_fields(
1122 &tool_use.id,
1123 acp::ToolCallUpdateFields::new()
1124 .status(status)
1125 .raw_output(output),
1126 None,
1127 );
1128 }
1129
1130 pub fn from_db(
1131 id: acp::SessionId,
1132 db_thread: DbThread,
1133 project: Entity<Project>,
1134 project_context: Entity<ProjectContext>,
1135 context_server_registry: Entity<ContextServerRegistry>,
1136 templates: Arc<Templates>,
1137 cx: &mut Context<Self>,
1138 ) -> Self {
1139 let settings = AgentSettings::get_global(cx);
1140 let profile_id = db_thread
1141 .profile
1142 .unwrap_or_else(|| settings.default_profile.clone());
1143
1144 let mut model = LanguageModelRegistry::global(cx).update(cx, |registry, cx| {
1145 db_thread
1146 .model
1147 .and_then(|model| {
1148 let model = SelectedModel {
1149 provider: model.provider.clone().into(),
1150 model: model.model.into(),
1151 };
1152 registry.select_model(&model, cx)
1153 })
1154 .or_else(|| registry.default_model())
1155 .map(|model| model.model)
1156 });
1157
1158 if model.is_none() {
1159 model = Self::resolve_profile_model(&profile_id, cx);
1160 }
1161 if model.is_none() {
1162 model = LanguageModelRegistry::global(cx).update(cx, |registry, _cx| {
1163 registry.default_model().map(|model| model.model)
1164 });
1165 }
1166
1167 let (prompt_capabilities_tx, prompt_capabilities_rx) =
1168 watch::channel(Self::prompt_capabilities(model.as_deref()));
1169
1170 let action_log = cx.new(|_| ActionLog::new(project.clone()));
1171
1172 Self {
1173 id,
1174 prompt_id: PromptId::new(),
1175 title: if db_thread.title.is_empty() {
1176 None
1177 } else {
1178 Some(db_thread.title.clone())
1179 },
1180 pending_title_generation: None,
1181 pending_summary_generation: None,
1182 summary: db_thread.detailed_summary,
1183 messages: db_thread.messages,
1184 user_store: project.read(cx).user_store(),
1185 running_turn: None,
1186 has_queued_message: false,
1187 pending_message: None,
1188 tools: BTreeMap::default(),
1189 request_token_usage: db_thread.request_token_usage.clone(),
1190 cumulative_token_usage: db_thread.cumulative_token_usage,
1191 initial_project_snapshot: Task::ready(db_thread.initial_project_snapshot).shared(),
1192 context_server_registry,
1193 profile_id,
1194 project_context,
1195 templates,
1196 model,
1197 summarization_model: None,
1198 thinking_enabled: db_thread.thinking_enabled,
1199 thinking_effort: db_thread.thinking_effort,
1200 speed: db_thread.speed,
1201 project,
1202 action_log,
1203 updated_at: db_thread.updated_at,
1204 prompt_capabilities_tx,
1205 prompt_capabilities_rx,
1206 file_read_times: HashMap::default(),
1207 imported: db_thread.imported,
1208 subagent_context: db_thread.subagent_context,
1209 running_subagents: Vec::new(),
1210 }
1211 }
1212
1213 pub fn to_db(&self, cx: &App) -> Task<DbThread> {
1214 let initial_project_snapshot = self.initial_project_snapshot.clone();
1215 let mut thread = DbThread {
1216 title: self.title(),
1217 messages: self.messages.clone(),
1218 updated_at: self.updated_at,
1219 detailed_summary: self.summary.clone(),
1220 initial_project_snapshot: None,
1221 cumulative_token_usage: self.cumulative_token_usage,
1222 request_token_usage: self.request_token_usage.clone(),
1223 model: self.model.as_ref().map(|model| DbLanguageModel {
1224 provider: model.provider_id().to_string(),
1225 model: model.id().0.to_string(),
1226 }),
1227 profile: Some(self.profile_id.clone()),
1228 imported: self.imported,
1229 subagent_context: self.subagent_context.clone(),
1230 speed: self.speed,
1231 thinking_enabled: self.thinking_enabled,
1232 thinking_effort: self.thinking_effort.clone(),
1233 };
1234
1235 cx.background_spawn(async move {
1236 let initial_project_snapshot = initial_project_snapshot.await;
1237 thread.initial_project_snapshot = initial_project_snapshot;
1238 thread
1239 })
1240 }
1241
1242 /// Create a snapshot of the current project state including git information and unsaved buffers.
1243 fn project_snapshot(
1244 project: Entity<Project>,
1245 cx: &mut Context<Self>,
1246 ) -> Task<Arc<ProjectSnapshot>> {
1247 let task = project::telemetry_snapshot::TelemetrySnapshot::new(&project, cx);
1248 cx.spawn(async move |_, _| {
1249 let snapshot = task.await;
1250
1251 Arc::new(ProjectSnapshot {
1252 worktree_snapshots: snapshot.worktree_snapshots,
1253 timestamp: Utc::now(),
1254 })
1255 })
1256 }
1257
1258 pub fn project_context(&self) -> &Entity<ProjectContext> {
1259 &self.project_context
1260 }
1261
1262 pub fn project(&self) -> &Entity<Project> {
1263 &self.project
1264 }
1265
1266 pub fn action_log(&self) -> &Entity<ActionLog> {
1267 &self.action_log
1268 }
1269
1270 pub fn is_empty(&self) -> bool {
1271 self.messages.is_empty() && self.title.is_none()
1272 }
1273
1274 pub fn model(&self) -> Option<&Arc<dyn LanguageModel>> {
1275 self.model.as_ref()
1276 }
1277
1278 pub fn set_model(&mut self, model: Arc<dyn LanguageModel>, cx: &mut Context<Self>) {
1279 let old_usage = self.latest_token_usage();
1280 self.model = Some(model);
1281 let new_caps = Self::prompt_capabilities(self.model.as_deref());
1282 let new_usage = self.latest_token_usage();
1283 if old_usage != new_usage {
1284 cx.emit(TokenUsageUpdated(new_usage));
1285 }
1286 self.prompt_capabilities_tx.send(new_caps).log_err();
1287 cx.notify()
1288 }
1289
1290 pub fn summarization_model(&self) -> Option<&Arc<dyn LanguageModel>> {
1291 self.summarization_model.as_ref()
1292 }
1293
1294 pub fn set_summarization_model(
1295 &mut self,
1296 model: Option<Arc<dyn LanguageModel>>,
1297 cx: &mut Context<Self>,
1298 ) {
1299 self.summarization_model = model;
1300 cx.notify()
1301 }
1302
1303 pub fn thinking_enabled(&self) -> bool {
1304 self.thinking_enabled
1305 }
1306
1307 pub fn set_thinking_enabled(&mut self, enabled: bool, cx: &mut Context<Self>) {
1308 self.thinking_enabled = enabled;
1309 cx.notify();
1310 }
1311
1312 pub fn thinking_effort(&self) -> Option<&String> {
1313 self.thinking_effort.as_ref()
1314 }
1315
1316 pub fn set_thinking_effort(&mut self, effort: Option<String>, cx: &mut Context<Self>) {
1317 self.thinking_effort = effort;
1318 cx.notify();
1319 }
1320
1321 pub fn speed(&self) -> Option<Speed> {
1322 self.speed
1323 }
1324
1325 pub fn set_speed(&mut self, speed: Speed, cx: &mut Context<Self>) {
1326 self.speed = Some(speed);
1327 cx.notify();
1328 }
1329
1330 pub fn last_message(&self) -> Option<&Message> {
1331 self.messages.last()
1332 }
1333
1334 pub fn num_messages(&self) -> usize {
1335 self.messages.len()
1336 }
1337
1338 #[cfg(any(test, feature = "test-support"))]
1339 pub fn last_received_or_pending_message(&self) -> Option<Message> {
1340 if let Some(message) = self.pending_message.clone() {
1341 Some(Message::Agent(message))
1342 } else {
1343 self.messages.last().cloned()
1344 }
1345 }
1346
1347 pub fn add_default_tools(
1348 &mut self,
1349 environment: Rc<dyn ThreadEnvironment>,
1350 cx: &mut Context<Self>,
1351 ) {
1352 let language_registry = self.project.read(cx).languages().clone();
1353 self.add_tool(CopyPathTool::new(self.project.clone()));
1354 self.add_tool(CreateDirectoryTool::new(self.project.clone()));
1355 self.add_tool(DeletePathTool::new(
1356 self.project.clone(),
1357 self.action_log.clone(),
1358 ));
1359 self.add_tool(DiagnosticsTool::new(self.project.clone()));
1360 self.add_tool(EditFileTool::new(
1361 self.project.clone(),
1362 cx.weak_entity(),
1363 language_registry.clone(),
1364 Templates::new(),
1365 ));
1366 self.add_tool(StreamingEditFileTool::new(
1367 self.project.clone(),
1368 cx.weak_entity(),
1369 language_registry,
1370 ));
1371 self.add_tool(FetchTool::new(self.project.read(cx).client().http_client()));
1372 self.add_tool(FindPathTool::new(self.project.clone()));
1373 self.add_tool(GrepTool::new(self.project.clone()));
1374 self.add_tool(ListDirectoryTool::new(self.project.clone()));
1375 self.add_tool(MovePathTool::new(self.project.clone()));
1376 self.add_tool(NowTool);
1377 self.add_tool(OpenTool::new(self.project.clone()));
1378 self.add_tool(ReadFileTool::new(
1379 cx.weak_entity(),
1380 self.project.clone(),
1381 self.action_log.clone(),
1382 ));
1383 self.add_tool(SaveFileTool::new(self.project.clone()));
1384 self.add_tool(RestoreFileFromDiskTool::new(self.project.clone()));
1385 self.add_tool(TerminalTool::new(self.project.clone(), environment.clone()));
1386 self.add_tool(WebSearchTool);
1387
1388 if self.depth() < MAX_SUBAGENT_DEPTH {
1389 self.add_tool(SpawnAgentTool::new(environment));
1390 }
1391 }
1392
1393 pub fn add_tool<T: AgentTool>(&mut self, tool: T) {
1394 debug_assert!(
1395 !self.tools.contains_key(T::NAME),
1396 "Duplicate tool name: {}",
1397 T::NAME,
1398 );
1399 self.tools.insert(T::NAME.into(), tool.erase());
1400 }
1401
1402 pub fn remove_tool(&mut self, name: &str) -> bool {
1403 self.tools.remove(name).is_some()
1404 }
1405
1406 pub fn profile(&self) -> &AgentProfileId {
1407 &self.profile_id
1408 }
1409
1410 pub fn set_profile(&mut self, profile_id: AgentProfileId, cx: &mut Context<Self>) {
1411 if self.profile_id == profile_id {
1412 return;
1413 }
1414
1415 self.profile_id = profile_id;
1416
1417 // Swap to the profile's preferred model when available.
1418 if let Some(model) = Self::resolve_profile_model(&self.profile_id, cx) {
1419 self.set_model(model, cx);
1420 }
1421 }
1422
1423 pub fn cancel(&mut self, cx: &mut Context<Self>) -> Task<()> {
1424 for subagent in self.running_subagents.drain(..) {
1425 if let Some(subagent) = subagent.upgrade() {
1426 subagent.update(cx, |thread, cx| thread.cancel(cx)).detach();
1427 }
1428 }
1429
1430 let Some(running_turn) = self.running_turn.take() else {
1431 self.flush_pending_message(cx);
1432 return Task::ready(());
1433 };
1434
1435 let turn_task = running_turn.cancel();
1436
1437 cx.spawn(async move |this, cx| {
1438 turn_task.await;
1439 this.update(cx, |this, cx| {
1440 this.flush_pending_message(cx);
1441 })
1442 .ok();
1443 })
1444 }
1445
1446 pub fn set_has_queued_message(&mut self, has_queued: bool) {
1447 self.has_queued_message = has_queued;
1448 }
1449
1450 pub fn has_queued_message(&self) -> bool {
1451 self.has_queued_message
1452 }
1453
1454 fn update_token_usage(&mut self, update: language_model::TokenUsage, cx: &mut Context<Self>) {
1455 let Some(last_user_message) = self.last_user_message() else {
1456 return;
1457 };
1458
1459 self.request_token_usage
1460 .insert(last_user_message.id.clone(), update);
1461 cx.emit(TokenUsageUpdated(self.latest_token_usage()));
1462 cx.notify();
1463 }
1464
1465 pub fn truncate(&mut self, message_id: UserMessageId, cx: &mut Context<Self>) -> Result<()> {
1466 self.cancel(cx).detach();
1467 // Clear pending message since cancel will try to flush it asynchronously,
1468 // and we don't want that content to be added after we truncate
1469 self.pending_message.take();
1470 let Some(position) = self.messages.iter().position(
1471 |msg| matches!(msg, Message::User(UserMessage { id, .. }) if id == &message_id),
1472 ) else {
1473 return Err(anyhow!("Message not found"));
1474 };
1475
1476 for message in self.messages.drain(position..) {
1477 match message {
1478 Message::User(message) => {
1479 self.request_token_usage.remove(&message.id);
1480 }
1481 Message::Agent(_) | Message::Resume => {}
1482 }
1483 }
1484 self.clear_summary();
1485 cx.notify();
1486 Ok(())
1487 }
1488
1489 pub fn latest_request_token_usage(&self) -> Option<language_model::TokenUsage> {
1490 let last_user_message = self.last_user_message()?;
1491 let tokens = self.request_token_usage.get(&last_user_message.id)?;
1492 Some(*tokens)
1493 }
1494
1495 pub fn latest_token_usage(&self) -> Option<acp_thread::TokenUsage> {
1496 let usage = self.latest_request_token_usage()?;
1497 let model = self.model.clone()?;
1498 Some(acp_thread::TokenUsage {
1499 max_tokens: model.max_token_count(),
1500 max_output_tokens: model.max_output_tokens(),
1501 used_tokens: usage.total_tokens(),
1502 input_tokens: usage.input_tokens,
1503 output_tokens: usage.output_tokens,
1504 })
1505 }
1506
1507 /// Get the total input token count as of the message before the given message.
1508 ///
1509 /// Returns `None` if:
1510 /// - `target_id` is the first message (no previous message)
1511 /// - The previous message hasn't received a response yet (no usage data)
1512 /// - `target_id` is not found in the messages
1513 pub fn tokens_before_message(&self, target_id: &UserMessageId) -> Option<u64> {
1514 let mut previous_user_message_id: Option<&UserMessageId> = None;
1515
1516 for message in &self.messages {
1517 if let Message::User(user_msg) = message {
1518 if &user_msg.id == target_id {
1519 let prev_id = previous_user_message_id?;
1520 let usage = self.request_token_usage.get(prev_id)?;
1521 return Some(usage.input_tokens);
1522 }
1523 previous_user_message_id = Some(&user_msg.id);
1524 }
1525 }
1526 None
1527 }
1528
1529 /// Look up the active profile and resolve its preferred model if one is configured.
1530 fn resolve_profile_model(
1531 profile_id: &AgentProfileId,
1532 cx: &mut Context<Self>,
1533 ) -> Option<Arc<dyn LanguageModel>> {
1534 let selection = AgentSettings::get_global(cx)
1535 .profiles
1536 .get(profile_id)?
1537 .default_model
1538 .clone()?;
1539 Self::resolve_model_from_selection(&selection, cx)
1540 }
1541
1542 /// Translate a stored model selection into the configured model from the registry.
1543 fn resolve_model_from_selection(
1544 selection: &LanguageModelSelection,
1545 cx: &mut Context<Self>,
1546 ) -> Option<Arc<dyn LanguageModel>> {
1547 let selected = SelectedModel {
1548 provider: LanguageModelProviderId::from(selection.provider.0.clone()),
1549 model: LanguageModelId::from(selection.model.clone()),
1550 };
1551 LanguageModelRegistry::global(cx).update(cx, |registry, cx| {
1552 registry
1553 .select_model(&selected, cx)
1554 .map(|configured| configured.model)
1555 })
1556 }
1557
1558 pub fn resume(
1559 &mut self,
1560 cx: &mut Context<Self>,
1561 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>> {
1562 self.messages.push(Message::Resume);
1563 cx.notify();
1564
1565 log::debug!("Total messages in thread: {}", self.messages.len());
1566 self.run_turn(cx)
1567 }
1568
1569 /// Sending a message results in the model streaming a response, which could include tool calls.
1570 /// After calling tools, the model will stops and waits for any outstanding tool calls to be completed and their results sent.
1571 /// The returned channel will report all the occurrences in which the model stops before erroring or ending its turn.
1572 pub fn send<T>(
1573 &mut self,
1574 id: UserMessageId,
1575 content: impl IntoIterator<Item = T>,
1576 cx: &mut Context<Self>,
1577 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>>
1578 where
1579 T: Into<UserMessageContent>,
1580 {
1581 let content = content.into_iter().map(Into::into).collect::<Vec<_>>();
1582 log::debug!("Thread::send content: {:?}", content);
1583
1584 self.messages
1585 .push(Message::User(UserMessage { id, content }));
1586 cx.notify();
1587
1588 self.send_existing(cx)
1589 }
1590
1591 pub fn send_existing(
1592 &mut self,
1593 cx: &mut Context<Self>,
1594 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>> {
1595 let model = self.model().context("No language model configured")?;
1596
1597 log::info!("Thread::send called with model: {}", model.name().0);
1598 self.advance_prompt_id();
1599
1600 log::debug!("Total messages in thread: {}", self.messages.len());
1601 self.run_turn(cx)
1602 }
1603
1604 pub fn push_acp_user_block(
1605 &mut self,
1606 id: UserMessageId,
1607 blocks: impl IntoIterator<Item = acp::ContentBlock>,
1608 path_style: PathStyle,
1609 cx: &mut Context<Self>,
1610 ) {
1611 let content = blocks
1612 .into_iter()
1613 .map(|block| UserMessageContent::from_content_block(block, path_style))
1614 .collect::<Vec<_>>();
1615 self.messages
1616 .push(Message::User(UserMessage { id, content }));
1617 cx.notify();
1618 }
1619
1620 pub fn push_acp_agent_block(&mut self, block: acp::ContentBlock, cx: &mut Context<Self>) {
1621 let text = match block {
1622 acp::ContentBlock::Text(text_content) => text_content.text,
1623 acp::ContentBlock::Image(_) => "[image]".to_string(),
1624 acp::ContentBlock::Audio(_) => "[audio]".to_string(),
1625 acp::ContentBlock::ResourceLink(resource_link) => resource_link.uri,
1626 acp::ContentBlock::Resource(resource) => match resource.resource {
1627 acp::EmbeddedResourceResource::TextResourceContents(resource) => resource.uri,
1628 acp::EmbeddedResourceResource::BlobResourceContents(resource) => resource.uri,
1629 _ => "[resource]".to_string(),
1630 },
1631 _ => "[unknown]".to_string(),
1632 };
1633
1634 self.messages.push(Message::Agent(AgentMessage {
1635 content: vec![AgentMessageContent::Text(text)],
1636 ..Default::default()
1637 }));
1638 cx.notify();
1639 }
1640
1641 #[cfg(feature = "eval")]
1642 pub fn proceed(
1643 &mut self,
1644 cx: &mut Context<Self>,
1645 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>> {
1646 self.run_turn(cx)
1647 }
1648
1649 fn run_turn(
1650 &mut self,
1651 cx: &mut Context<Self>,
1652 ) -> Result<mpsc::UnboundedReceiver<Result<ThreadEvent>>> {
1653 // Flush the old pending message synchronously before cancelling,
1654 // to avoid a race where the detached cancel task might flush the NEW
1655 // turn's pending message instead of the old one.
1656 self.flush_pending_message(cx);
1657 self.cancel(cx).detach();
1658
1659 let model = self.model.clone().context("No language model configured")?;
1660 let profile = AgentSettings::get_global(cx)
1661 .profiles
1662 .get(&self.profile_id)
1663 .context("Profile not found")?;
1664 let (events_tx, events_rx) = mpsc::unbounded::<Result<ThreadEvent>>();
1665 let event_stream = ThreadEventStream(events_tx);
1666 let message_ix = self.messages.len().saturating_sub(1);
1667 self.clear_summary();
1668 let (cancellation_tx, mut cancellation_rx) = watch::channel(false);
1669 self.running_turn = Some(RunningTurn {
1670 event_stream: event_stream.clone(),
1671 tools: self.enabled_tools(profile, &model, cx),
1672 cancellation_tx,
1673 streaming_tool_inputs: HashMap::default(),
1674 _task: cx.spawn(async move |this, cx| {
1675 log::debug!("Starting agent turn execution");
1676
1677 let turn_result = Self::run_turn_internal(
1678 &this,
1679 model,
1680 &event_stream,
1681 cancellation_rx.clone(),
1682 cx,
1683 )
1684 .await;
1685
1686 // Check if we were cancelled - if so, cancel() already took running_turn
1687 // and we shouldn't touch it (it might be a NEW turn now)
1688 let was_cancelled = *cancellation_rx.borrow();
1689 if was_cancelled {
1690 log::debug!("Turn was cancelled, skipping cleanup");
1691 return;
1692 }
1693
1694 _ = this.update(cx, |this, cx| this.flush_pending_message(cx));
1695
1696 match turn_result {
1697 Ok(()) => {
1698 log::debug!("Turn execution completed");
1699 event_stream.send_stop(acp::StopReason::EndTurn);
1700 }
1701 Err(error) => {
1702 log::error!("Turn execution failed: {:?}", error);
1703 match error.downcast::<CompletionError>() {
1704 Ok(CompletionError::Refusal) => {
1705 event_stream.send_stop(acp::StopReason::Refusal);
1706 _ = this.update(cx, |this, _| this.messages.truncate(message_ix));
1707 }
1708 Ok(CompletionError::MaxTokens) => {
1709 event_stream.send_stop(acp::StopReason::MaxTokens);
1710 }
1711 Ok(CompletionError::Other(error)) | Err(error) => {
1712 event_stream.send_error(error);
1713 }
1714 }
1715 }
1716 }
1717
1718 _ = this.update(cx, |this, _| this.running_turn.take());
1719 }),
1720 });
1721 Ok(events_rx)
1722 }
1723
1724 async fn run_turn_internal(
1725 this: &WeakEntity<Self>,
1726 model: Arc<dyn LanguageModel>,
1727 event_stream: &ThreadEventStream,
1728 mut cancellation_rx: watch::Receiver<bool>,
1729 cx: &mut AsyncApp,
1730 ) -> Result<()> {
1731 let mut attempt = 0;
1732 let mut intent = CompletionIntent::UserPrompt;
1733 loop {
1734 let request =
1735 this.update(cx, |this, cx| this.build_completion_request(intent, cx))??;
1736
1737 telemetry::event!(
1738 "Agent Thread Completion",
1739 thread_id = this.read_with(cx, |this, _| this.id.to_string())?,
1740 parent_thread_id = this.read_with(cx, |this, _| this
1741 .parent_thread_id()
1742 .map(|id| id.to_string()))?,
1743 prompt_id = this.read_with(cx, |this, _| this.prompt_id.to_string())?,
1744 model = model.telemetry_id(),
1745 model_provider = model.provider_id().to_string(),
1746 attempt
1747 );
1748
1749 log::debug!("Calling model.stream_completion, attempt {}", attempt);
1750
1751 let (mut events, mut error) = match model.stream_completion(request, cx).await {
1752 Ok(events) => (events.fuse(), None),
1753 Err(err) => (stream::empty().boxed().fuse(), Some(err)),
1754 };
1755 let mut tool_results = FuturesUnordered::new();
1756 let mut cancelled = false;
1757 loop {
1758 // Race between getting the first event and cancellation
1759 let first_event = futures::select! {
1760 event = events.next().fuse() => event,
1761 _ = cancellation_rx.changed().fuse() => {
1762 if *cancellation_rx.borrow() {
1763 cancelled = true;
1764 break;
1765 }
1766 continue;
1767 }
1768 };
1769 let Some(first_event) = first_event else {
1770 break;
1771 };
1772
1773 // Collect all immediately available events to process as a batch
1774 let mut batch = vec![first_event];
1775 while let Some(event) = events.next().now_or_never().flatten() {
1776 batch.push(event);
1777 }
1778
1779 // Process the batch in a single update
1780 let batch_result = this.update(cx, |this, cx| {
1781 let mut batch_tool_results = Vec::new();
1782 let mut batch_error = None;
1783
1784 for event in batch {
1785 log::trace!("Received completion event: {:?}", event);
1786 match event {
1787 Ok(event) => {
1788 match this.handle_completion_event(
1789 event,
1790 event_stream,
1791 cancellation_rx.clone(),
1792 cx,
1793 ) {
1794 Ok(Some(task)) => batch_tool_results.push(task),
1795 Ok(None) => {}
1796 Err(err) => {
1797 batch_error = Some(err);
1798 break;
1799 }
1800 }
1801 }
1802 Err(err) => {
1803 batch_error = Some(err.into());
1804 break;
1805 }
1806 }
1807 }
1808
1809 cx.notify();
1810 (batch_tool_results, batch_error)
1811 })?;
1812
1813 tool_results.extend(batch_result.0);
1814 if let Some(err) = batch_result.1 {
1815 error = Some(err.downcast()?);
1816 break;
1817 }
1818 }
1819
1820 // Drop the stream to release the rate limit permit before tool execution.
1821 // The stream holds a semaphore guard that limits concurrent requests.
1822 // Without this, the permit would be held during potentially long-running
1823 // tool execution, which could cause deadlocks when tools spawn subagents
1824 // that need their own permits.
1825 drop(events);
1826
1827 let end_turn = tool_results.is_empty();
1828 while let Some(tool_result) = tool_results.next().await {
1829 log::debug!("Tool finished {:?}", tool_result);
1830
1831 event_stream.update_tool_call_fields(
1832 &tool_result.tool_use_id,
1833 acp::ToolCallUpdateFields::new()
1834 .status(if tool_result.is_error {
1835 acp::ToolCallStatus::Failed
1836 } else {
1837 acp::ToolCallStatus::Completed
1838 })
1839 .raw_output(tool_result.output.clone()),
1840 None,
1841 );
1842 this.update(cx, |this, _cx| {
1843 this.pending_message()
1844 .tool_results
1845 .insert(tool_result.tool_use_id.clone(), tool_result);
1846 })?;
1847 }
1848
1849 this.update(cx, |this, cx| {
1850 this.flush_pending_message(cx);
1851 if this.title.is_none() && this.pending_title_generation.is_none() {
1852 this.generate_title(cx);
1853 }
1854 })?;
1855
1856 if cancelled {
1857 log::debug!("Turn cancelled by user, exiting");
1858 return Ok(());
1859 }
1860
1861 if let Some(error) = error {
1862 attempt += 1;
1863 let retry = this.update(cx, |this, cx| {
1864 let user_store = this.user_store.read(cx);
1865 this.handle_completion_error(error, attempt, user_store.plan())
1866 })??;
1867 let timer = cx.background_executor().timer(retry.duration);
1868 event_stream.send_retry(retry);
1869 timer.await;
1870 this.update(cx, |this, _cx| {
1871 if let Some(Message::Agent(message)) = this.messages.last() {
1872 if message.tool_results.is_empty() {
1873 intent = CompletionIntent::UserPrompt;
1874 this.messages.push(Message::Resume);
1875 }
1876 }
1877 })?;
1878 } else if end_turn {
1879 return Ok(());
1880 } else {
1881 let has_queued = this.update(cx, |this, _| this.has_queued_message())?;
1882 if has_queued {
1883 log::debug!("Queued message found, ending turn at message boundary");
1884 return Ok(());
1885 }
1886 intent = CompletionIntent::ToolResults;
1887 attempt = 0;
1888 }
1889 }
1890 }
1891
1892 fn handle_completion_error(
1893 &mut self,
1894 error: LanguageModelCompletionError,
1895 attempt: u8,
1896 plan: Option<Plan>,
1897 ) -> Result<acp_thread::RetryStatus> {
1898 let Some(model) = self.model.as_ref() else {
1899 return Err(anyhow!(error));
1900 };
1901
1902 let auto_retry = if model.provider_id() == ZED_CLOUD_PROVIDER_ID {
1903 plan.is_some()
1904 } else {
1905 true
1906 };
1907
1908 if !auto_retry {
1909 return Err(anyhow!(error));
1910 }
1911
1912 let Some(strategy) = Self::retry_strategy_for(&error) else {
1913 return Err(anyhow!(error));
1914 };
1915
1916 let max_attempts = match &strategy {
1917 RetryStrategy::ExponentialBackoff { max_attempts, .. } => *max_attempts,
1918 RetryStrategy::Fixed { max_attempts, .. } => *max_attempts,
1919 };
1920
1921 if attempt > max_attempts {
1922 return Err(anyhow!(error));
1923 }
1924
1925 let delay = match &strategy {
1926 RetryStrategy::ExponentialBackoff { initial_delay, .. } => {
1927 let delay_secs = initial_delay.as_secs() * 2u64.pow((attempt - 1) as u32);
1928 Duration::from_secs(delay_secs)
1929 }
1930 RetryStrategy::Fixed { delay, .. } => *delay,
1931 };
1932 log::debug!("Retry attempt {attempt} with delay {delay:?}");
1933
1934 Ok(acp_thread::RetryStatus {
1935 last_error: error.to_string().into(),
1936 attempt: attempt as usize,
1937 max_attempts: max_attempts as usize,
1938 started_at: Instant::now(),
1939 duration: delay,
1940 })
1941 }
1942
1943 /// A helper method that's called on every streamed completion event.
1944 /// Returns an optional tool result task, which the main agentic loop will
1945 /// send back to the model when it resolves.
1946 fn handle_completion_event(
1947 &mut self,
1948 event: LanguageModelCompletionEvent,
1949 event_stream: &ThreadEventStream,
1950 cancellation_rx: watch::Receiver<bool>,
1951 cx: &mut Context<Self>,
1952 ) -> Result<Option<Task<LanguageModelToolResult>>> {
1953 log::trace!("Handling streamed completion event: {:?}", event);
1954 use LanguageModelCompletionEvent::*;
1955
1956 match event {
1957 StartMessage { .. } => {
1958 self.flush_pending_message(cx);
1959 self.pending_message = Some(AgentMessage::default());
1960 }
1961 Text(new_text) => self.handle_text_event(new_text, event_stream),
1962 Thinking { text, signature } => {
1963 self.handle_thinking_event(text, signature, event_stream)
1964 }
1965 RedactedThinking { data } => self.handle_redacted_thinking_event(data),
1966 ReasoningDetails(details) => {
1967 let last_message = self.pending_message();
1968 // Store the last non-empty reasoning_details (overwrites earlier ones)
1969 // This ensures we keep the encrypted reasoning with signatures, not the early text reasoning
1970 if let serde_json::Value::Array(ref arr) = details {
1971 if !arr.is_empty() {
1972 last_message.reasoning_details = Some(details);
1973 }
1974 } else {
1975 last_message.reasoning_details = Some(details);
1976 }
1977 }
1978 ToolUse(tool_use) => {
1979 return Ok(self.handle_tool_use_event(tool_use, event_stream, cancellation_rx, cx));
1980 }
1981 ToolUseJsonParseError {
1982 id,
1983 tool_name,
1984 raw_input,
1985 json_parse_error,
1986 } => {
1987 return Ok(Some(Task::ready(
1988 self.handle_tool_use_json_parse_error_event(
1989 id,
1990 tool_name,
1991 raw_input,
1992 json_parse_error,
1993 event_stream,
1994 ),
1995 )));
1996 }
1997 UsageUpdate(usage) => {
1998 telemetry::event!(
1999 "Agent Thread Completion Usage Updated",
2000 thread_id = self.id.to_string(),
2001 parent_thread_id = self.parent_thread_id().map(|id| id.to_string()),
2002 prompt_id = self.prompt_id.to_string(),
2003 model = self.model.as_ref().map(|m| m.telemetry_id()),
2004 model_provider = self.model.as_ref().map(|m| m.provider_id().to_string()),
2005 input_tokens = usage.input_tokens,
2006 output_tokens = usage.output_tokens,
2007 cache_creation_input_tokens = usage.cache_creation_input_tokens,
2008 cache_read_input_tokens = usage.cache_read_input_tokens,
2009 );
2010 self.update_token_usage(usage, cx);
2011 }
2012 Stop(StopReason::Refusal) => return Err(CompletionError::Refusal.into()),
2013 Stop(StopReason::MaxTokens) => return Err(CompletionError::MaxTokens.into()),
2014 Stop(StopReason::ToolUse | StopReason::EndTurn) => {}
2015 Started | Queued { .. } => {}
2016 }
2017
2018 Ok(None)
2019 }
2020
2021 fn handle_text_event(&mut self, new_text: String, event_stream: &ThreadEventStream) {
2022 event_stream.send_text(&new_text);
2023
2024 let last_message = self.pending_message();
2025 if let Some(AgentMessageContent::Text(text)) = last_message.content.last_mut() {
2026 text.push_str(&new_text);
2027 } else {
2028 last_message
2029 .content
2030 .push(AgentMessageContent::Text(new_text));
2031 }
2032 }
2033
2034 fn handle_thinking_event(
2035 &mut self,
2036 new_text: String,
2037 new_signature: Option<String>,
2038 event_stream: &ThreadEventStream,
2039 ) {
2040 event_stream.send_thinking(&new_text);
2041
2042 let last_message = self.pending_message();
2043 if let Some(AgentMessageContent::Thinking { text, signature }) =
2044 last_message.content.last_mut()
2045 {
2046 text.push_str(&new_text);
2047 *signature = new_signature.or(signature.take());
2048 } else {
2049 last_message.content.push(AgentMessageContent::Thinking {
2050 text: new_text,
2051 signature: new_signature,
2052 });
2053 }
2054 }
2055
2056 fn handle_redacted_thinking_event(&mut self, data: String) {
2057 let last_message = self.pending_message();
2058 last_message
2059 .content
2060 .push(AgentMessageContent::RedactedThinking(data));
2061 }
2062
2063 fn handle_tool_use_event(
2064 &mut self,
2065 tool_use: LanguageModelToolUse,
2066 event_stream: &ThreadEventStream,
2067 cancellation_rx: watch::Receiver<bool>,
2068 cx: &mut Context<Self>,
2069 ) -> Option<Task<LanguageModelToolResult>> {
2070 cx.notify();
2071
2072 let tool = self.tool(tool_use.name.as_ref());
2073 let mut title = SharedString::from(&tool_use.name);
2074 let mut kind = acp::ToolKind::Other;
2075 if let Some(tool) = tool.as_ref() {
2076 title = tool.initial_title(tool_use.input.clone(), cx);
2077 kind = tool.kind();
2078 }
2079
2080 self.send_or_update_tool_use(&tool_use, title, kind, event_stream);
2081
2082 let Some(tool) = tool else {
2083 let content = format!("No tool named {} exists", tool_use.name);
2084 return Some(Task::ready(LanguageModelToolResult {
2085 content: LanguageModelToolResultContent::Text(Arc::from(content)),
2086 tool_use_id: tool_use.id,
2087 tool_name: tool_use.name,
2088 is_error: true,
2089 output: None,
2090 }));
2091 };
2092
2093 if !tool_use.is_input_complete {
2094 if tool.supports_input_streaming() {
2095 let running_turn = self.running_turn.as_mut()?;
2096 if let Some(sender) = running_turn.streaming_tool_inputs.get(&tool_use.id) {
2097 sender.send_partial(tool_use.input);
2098 return None;
2099 }
2100
2101 let (sender, tool_input) = ToolInputSender::channel();
2102 sender.send_partial(tool_use.input);
2103 running_turn
2104 .streaming_tool_inputs
2105 .insert(tool_use.id.clone(), sender);
2106
2107 let tool = tool.clone();
2108 log::debug!("Running streaming tool {}", tool_use.name);
2109 return Some(self.run_tool(
2110 tool,
2111 tool_input,
2112 tool_use.id,
2113 tool_use.name,
2114 event_stream,
2115 cancellation_rx,
2116 cx,
2117 ));
2118 } else {
2119 return None;
2120 }
2121 }
2122
2123 if let Some(sender) = self
2124 .running_turn
2125 .as_mut()?
2126 .streaming_tool_inputs
2127 .remove(&tool_use.id)
2128 {
2129 sender.send_final(tool_use.input);
2130 return None;
2131 }
2132
2133 log::debug!("Running tool {}", tool_use.name);
2134 let tool_input = ToolInput::ready(tool_use.input);
2135 Some(self.run_tool(
2136 tool,
2137 tool_input,
2138 tool_use.id,
2139 tool_use.name,
2140 event_stream,
2141 cancellation_rx,
2142 cx,
2143 ))
2144 }
2145
2146 fn run_tool(
2147 &self,
2148 tool: Arc<dyn AnyAgentTool>,
2149 tool_input: ToolInput<serde_json::Value>,
2150 tool_use_id: LanguageModelToolUseId,
2151 tool_name: Arc<str>,
2152 event_stream: &ThreadEventStream,
2153 cancellation_rx: watch::Receiver<bool>,
2154 cx: &mut Context<Self>,
2155 ) -> Task<LanguageModelToolResult> {
2156 let fs = self.project.read(cx).fs().clone();
2157 let tool_event_stream = ToolCallEventStream::new(
2158 tool_use_id.clone(),
2159 event_stream.clone(),
2160 Some(fs),
2161 cancellation_rx,
2162 );
2163 tool_event_stream.update_fields(
2164 acp::ToolCallUpdateFields::new().status(acp::ToolCallStatus::InProgress),
2165 );
2166 let supports_images = self.model().is_some_and(|model| model.supports_images());
2167 let tool_result = tool.run(tool_input, tool_event_stream, cx);
2168 cx.foreground_executor().spawn(async move {
2169 let (is_error, output) = match tool_result.await {
2170 Ok(mut output) => {
2171 if let LanguageModelToolResultContent::Image(_) = &output.llm_output
2172 && !supports_images
2173 {
2174 output = AgentToolOutput::from_error(
2175 "Attempted to read an image, but this model doesn't support it.",
2176 );
2177 (true, output)
2178 } else {
2179 (false, output)
2180 }
2181 }
2182 Err(output) => (true, output),
2183 };
2184
2185 LanguageModelToolResult {
2186 tool_use_id,
2187 tool_name,
2188 is_error,
2189 content: output.llm_output,
2190 output: Some(output.raw_output),
2191 }
2192 })
2193 }
2194
2195 fn handle_tool_use_json_parse_error_event(
2196 &mut self,
2197 tool_use_id: LanguageModelToolUseId,
2198 tool_name: Arc<str>,
2199 raw_input: Arc<str>,
2200 json_parse_error: String,
2201 event_stream: &ThreadEventStream,
2202 ) -> LanguageModelToolResult {
2203 let tool_use = LanguageModelToolUse {
2204 id: tool_use_id.clone(),
2205 name: tool_name.clone(),
2206 raw_input: raw_input.to_string(),
2207 input: serde_json::json!({}),
2208 is_input_complete: true,
2209 thought_signature: None,
2210 };
2211 self.send_or_update_tool_use(
2212 &tool_use,
2213 SharedString::from(&tool_use.name),
2214 acp::ToolKind::Other,
2215 event_stream,
2216 );
2217
2218 let tool_output = format!("Error parsing input JSON: {json_parse_error}");
2219 LanguageModelToolResult {
2220 tool_use_id,
2221 tool_name,
2222 is_error: true,
2223 content: LanguageModelToolResultContent::Text(tool_output.into()),
2224 output: Some(serde_json::Value::String(raw_input.to_string())),
2225 }
2226 }
2227
2228 fn send_or_update_tool_use(
2229 &mut self,
2230 tool_use: &LanguageModelToolUse,
2231 title: SharedString,
2232 kind: acp::ToolKind,
2233 event_stream: &ThreadEventStream,
2234 ) {
2235 // Ensure the last message ends in the current tool use
2236 let last_message = self.pending_message();
2237 let push_new_tool_use = last_message.content.last_mut().is_none_or(|content| {
2238 if let AgentMessageContent::ToolUse(last_tool_use) = content {
2239 if last_tool_use.id == tool_use.id {
2240 *last_tool_use = tool_use.clone();
2241 false
2242 } else {
2243 true
2244 }
2245 } else {
2246 true
2247 }
2248 });
2249
2250 if push_new_tool_use {
2251 event_stream.send_tool_call(
2252 &tool_use.id,
2253 &tool_use.name,
2254 title,
2255 kind,
2256 tool_use.input.clone(),
2257 );
2258 last_message
2259 .content
2260 .push(AgentMessageContent::ToolUse(tool_use.clone()));
2261 } else {
2262 event_stream.update_tool_call_fields(
2263 &tool_use.id,
2264 acp::ToolCallUpdateFields::new()
2265 .title(title.as_str())
2266 .kind(kind)
2267 .raw_input(tool_use.input.clone()),
2268 None,
2269 );
2270 }
2271 }
2272
2273 pub fn title(&self) -> SharedString {
2274 self.title.clone().unwrap_or("New Thread".into())
2275 }
2276
2277 pub fn is_generating_summary(&self) -> bool {
2278 self.pending_summary_generation.is_some()
2279 }
2280
2281 pub fn is_generating_title(&self) -> bool {
2282 self.pending_title_generation.is_some()
2283 }
2284
2285 pub fn summary(&mut self, cx: &mut Context<Self>) -> Shared<Task<Option<SharedString>>> {
2286 if let Some(summary) = self.summary.as_ref() {
2287 return Task::ready(Some(summary.clone())).shared();
2288 }
2289 if let Some(task) = self.pending_summary_generation.clone() {
2290 return task;
2291 }
2292 let Some(model) = self.summarization_model.clone() else {
2293 log::error!("No summarization model available");
2294 return Task::ready(None).shared();
2295 };
2296 let mut request = LanguageModelRequest {
2297 intent: Some(CompletionIntent::ThreadContextSummarization),
2298 temperature: AgentSettings::temperature_for_model(&model, cx),
2299 ..Default::default()
2300 };
2301
2302 for message in &self.messages {
2303 request.messages.extend(message.to_request());
2304 }
2305
2306 request.messages.push(LanguageModelRequestMessage {
2307 role: Role::User,
2308 content: vec![SUMMARIZE_THREAD_DETAILED_PROMPT.into()],
2309 cache: false,
2310 reasoning_details: None,
2311 });
2312
2313 let task = cx
2314 .spawn(async move |this, cx| {
2315 let mut summary = String::new();
2316 let mut messages = model.stream_completion(request, cx).await.log_err()?;
2317 while let Some(event) = messages.next().await {
2318 let event = event.log_err()?;
2319 let text = match event {
2320 LanguageModelCompletionEvent::Text(text) => text,
2321 _ => continue,
2322 };
2323
2324 let mut lines = text.lines();
2325 summary.extend(lines.next());
2326 }
2327
2328 log::debug!("Setting summary: {}", summary);
2329 let summary = SharedString::from(summary);
2330
2331 this.update(cx, |this, cx| {
2332 this.summary = Some(summary.clone());
2333 this.pending_summary_generation = None;
2334 cx.notify()
2335 })
2336 .ok()?;
2337
2338 Some(summary)
2339 })
2340 .shared();
2341 self.pending_summary_generation = Some(task.clone());
2342 task
2343 }
2344
2345 pub fn generate_title(&mut self, cx: &mut Context<Self>) {
2346 let Some(model) = self.summarization_model.clone() else {
2347 return;
2348 };
2349
2350 log::debug!(
2351 "Generating title with model: {:?}",
2352 self.summarization_model.as_ref().map(|model| model.name())
2353 );
2354 let mut request = LanguageModelRequest {
2355 intent: Some(CompletionIntent::ThreadSummarization),
2356 temperature: AgentSettings::temperature_for_model(&model, cx),
2357 ..Default::default()
2358 };
2359
2360 for message in &self.messages {
2361 request.messages.extend(message.to_request());
2362 }
2363
2364 request.messages.push(LanguageModelRequestMessage {
2365 role: Role::User,
2366 content: vec![SUMMARIZE_THREAD_PROMPT.into()],
2367 cache: false,
2368 reasoning_details: None,
2369 });
2370 self.pending_title_generation = Some(cx.spawn(async move |this, cx| {
2371 let mut title = String::new();
2372
2373 let generate = async {
2374 let mut messages = model.stream_completion(request, cx).await?;
2375 while let Some(event) = messages.next().await {
2376 let event = event?;
2377 let text = match event {
2378 LanguageModelCompletionEvent::Text(text) => text,
2379 _ => continue,
2380 };
2381
2382 let mut lines = text.lines();
2383 title.extend(lines.next());
2384
2385 // Stop if the LLM generated multiple lines.
2386 if lines.next().is_some() {
2387 break;
2388 }
2389 }
2390 anyhow::Ok(())
2391 };
2392
2393 if generate
2394 .await
2395 .context("failed to generate thread title")
2396 .log_err()
2397 .is_some()
2398 {
2399 _ = this.update(cx, |this, cx| this.set_title(title.into(), cx));
2400 }
2401 _ = this.update(cx, |this, _| this.pending_title_generation = None);
2402 }));
2403 }
2404
2405 pub fn set_title(&mut self, title: SharedString, cx: &mut Context<Self>) {
2406 self.pending_title_generation = None;
2407 if Some(&title) != self.title.as_ref() {
2408 self.title = Some(title);
2409 cx.emit(TitleUpdated);
2410 cx.notify();
2411 }
2412 }
2413
2414 fn clear_summary(&mut self) {
2415 self.summary = None;
2416 self.pending_summary_generation = None;
2417 }
2418
2419 fn last_user_message(&self) -> Option<&UserMessage> {
2420 self.messages
2421 .iter()
2422 .rev()
2423 .find_map(|message| match message {
2424 Message::User(user_message) => Some(user_message),
2425 Message::Agent(_) => None,
2426 Message::Resume => None,
2427 })
2428 }
2429
2430 fn pending_message(&mut self) -> &mut AgentMessage {
2431 self.pending_message.get_or_insert_default()
2432 }
2433
2434 fn flush_pending_message(&mut self, cx: &mut Context<Self>) {
2435 let Some(mut message) = self.pending_message.take() else {
2436 return;
2437 };
2438
2439 if message.content.is_empty() {
2440 return;
2441 }
2442
2443 for content in &message.content {
2444 let AgentMessageContent::ToolUse(tool_use) = content else {
2445 continue;
2446 };
2447
2448 if !message.tool_results.contains_key(&tool_use.id) {
2449 message.tool_results.insert(
2450 tool_use.id.clone(),
2451 LanguageModelToolResult {
2452 tool_use_id: tool_use.id.clone(),
2453 tool_name: tool_use.name.clone(),
2454 is_error: true,
2455 content: LanguageModelToolResultContent::Text(TOOL_CANCELED_MESSAGE.into()),
2456 output: None,
2457 },
2458 );
2459 }
2460 }
2461
2462 self.messages.push(Message::Agent(message));
2463 self.updated_at = Utc::now();
2464 self.clear_summary();
2465 cx.notify()
2466 }
2467
2468 pub(crate) fn build_completion_request(
2469 &self,
2470 completion_intent: CompletionIntent,
2471 cx: &App,
2472 ) -> Result<LanguageModelRequest> {
2473 let model = self.model().context("No language model configured")?;
2474 let tools = if let Some(turn) = self.running_turn.as_ref() {
2475 turn.tools
2476 .iter()
2477 .filter_map(|(tool_name, tool)| {
2478 log::trace!("Including tool: {}", tool_name);
2479 Some(LanguageModelRequestTool {
2480 name: tool_name.to_string(),
2481 description: tool.description().to_string(),
2482 input_schema: tool.input_schema(model.tool_input_format()).log_err()?,
2483 use_input_streaming: tool.supports_input_streaming(),
2484 })
2485 })
2486 .collect::<Vec<_>>()
2487 } else {
2488 Vec::new()
2489 };
2490
2491 log::debug!("Building completion request");
2492 log::debug!("Completion intent: {:?}", completion_intent);
2493
2494 let available_tools: Vec<_> = self
2495 .running_turn
2496 .as_ref()
2497 .map(|turn| turn.tools.keys().cloned().collect())
2498 .unwrap_or_default();
2499
2500 log::debug!("Request includes {} tools", available_tools.len());
2501 let messages = self.build_request_messages(available_tools, cx);
2502 log::debug!("Request will include {} messages", messages.len());
2503
2504 let request = LanguageModelRequest {
2505 thread_id: Some(self.id.to_string()),
2506 prompt_id: Some(self.prompt_id.to_string()),
2507 intent: Some(completion_intent),
2508 messages,
2509 tools,
2510 tool_choice: None,
2511 stop: Vec::new(),
2512 temperature: AgentSettings::temperature_for_model(model, cx),
2513 thinking_allowed: self.thinking_enabled,
2514 thinking_effort: self.thinking_effort.clone(),
2515 speed: self.speed(),
2516 };
2517
2518 log::debug!("Completion request built successfully");
2519 Ok(request)
2520 }
2521
2522 fn enabled_tools(
2523 &self,
2524 profile: &AgentProfileSettings,
2525 model: &Arc<dyn LanguageModel>,
2526 cx: &App,
2527 ) -> BTreeMap<SharedString, Arc<dyn AnyAgentTool>> {
2528 fn truncate(tool_name: &SharedString) -> SharedString {
2529 if tool_name.len() > MAX_TOOL_NAME_LENGTH {
2530 let mut truncated = tool_name.to_string();
2531 truncated.truncate(MAX_TOOL_NAME_LENGTH);
2532 truncated.into()
2533 } else {
2534 tool_name.clone()
2535 }
2536 }
2537
2538 let use_streaming_edit_tool = cx.has_flag::<StreamingEditFileToolFeatureFlag>();
2539
2540 let mut tools = self
2541 .tools
2542 .iter()
2543 .filter_map(|(tool_name, tool)| {
2544 // For streaming_edit_file, check profile against "edit_file" since that's what users configure
2545 let profile_tool_name = if tool_name == StreamingEditFileTool::NAME {
2546 EditFileTool::NAME
2547 } else {
2548 tool_name.as_ref()
2549 };
2550
2551 if tool.supports_provider(&model.provider_id())
2552 && profile.is_tool_enabled(profile_tool_name)
2553 {
2554 match (tool_name.as_ref(), use_streaming_edit_tool) {
2555 (StreamingEditFileTool::NAME, false) | (EditFileTool::NAME, true) => None,
2556 (StreamingEditFileTool::NAME, true) => {
2557 // Expose streaming tool as "edit_file"
2558 Some((SharedString::from(EditFileTool::NAME), tool.clone()))
2559 }
2560 _ => Some((truncate(tool_name), tool.clone())),
2561 }
2562 } else {
2563 None
2564 }
2565 })
2566 .collect::<BTreeMap<_, _>>();
2567
2568 let mut context_server_tools = Vec::new();
2569 let mut seen_tools = tools.keys().cloned().collect::<HashSet<_>>();
2570 let mut duplicate_tool_names = HashSet::default();
2571 for (server_id, server_tools) in self.context_server_registry.read(cx).servers() {
2572 for (tool_name, tool) in server_tools {
2573 if profile.is_context_server_tool_enabled(&server_id.0, &tool_name) {
2574 let tool_name = truncate(tool_name);
2575 if !seen_tools.insert(tool_name.clone()) {
2576 duplicate_tool_names.insert(tool_name.clone());
2577 }
2578 context_server_tools.push((server_id.clone(), tool_name, tool.clone()));
2579 }
2580 }
2581 }
2582
2583 // When there are duplicate tool names, disambiguate by prefixing them
2584 // with the server ID (converted to snake_case for API compatibility).
2585 // In the rare case there isn't enough space for the disambiguated tool
2586 // name, keep only the last tool with this name.
2587 for (server_id, tool_name, tool) in context_server_tools {
2588 if duplicate_tool_names.contains(&tool_name) {
2589 let available = MAX_TOOL_NAME_LENGTH.saturating_sub(tool_name.len());
2590 if available >= 2 {
2591 let mut disambiguated = server_id.0.to_snake_case();
2592 disambiguated.truncate(available - 1);
2593 disambiguated.push('_');
2594 disambiguated.push_str(&tool_name);
2595 tools.insert(disambiguated.into(), tool.clone());
2596 } else {
2597 tools.insert(tool_name, tool.clone());
2598 }
2599 } else {
2600 tools.insert(tool_name, tool.clone());
2601 }
2602 }
2603
2604 tools
2605 }
2606
2607 fn tool(&self, name: &str) -> Option<Arc<dyn AnyAgentTool>> {
2608 self.running_turn.as_ref()?.tools.get(name).cloned()
2609 }
2610
2611 pub fn has_tool(&self, name: &str) -> bool {
2612 self.running_turn
2613 .as_ref()
2614 .is_some_and(|turn| turn.tools.contains_key(name))
2615 }
2616
2617 #[cfg(any(test, feature = "test-support"))]
2618 pub fn has_registered_tool(&self, name: &str) -> bool {
2619 self.tools.contains_key(name)
2620 }
2621
2622 pub fn registered_tool_names(&self) -> Vec<SharedString> {
2623 self.tools.keys().cloned().collect()
2624 }
2625
2626 pub(crate) fn register_running_subagent(&mut self, subagent: WeakEntity<Thread>) {
2627 self.running_subagents.push(subagent);
2628 }
2629
2630 pub(crate) fn unregister_running_subagent(
2631 &mut self,
2632 subagent_session_id: &acp::SessionId,
2633 cx: &App,
2634 ) {
2635 self.running_subagents.retain(|s| {
2636 s.upgrade()
2637 .map_or(false, |s| s.read(cx).id() != subagent_session_id)
2638 });
2639 }
2640
2641 #[cfg(any(test, feature = "test-support"))]
2642 pub fn running_subagent_ids(&self, cx: &App) -> Vec<acp::SessionId> {
2643 self.running_subagents
2644 .iter()
2645 .filter_map(|s| s.upgrade().map(|s| s.read(cx).id().clone()))
2646 .collect()
2647 }
2648
2649 pub fn is_subagent(&self) -> bool {
2650 self.subagent_context.is_some()
2651 }
2652
2653 pub fn parent_thread_id(&self) -> Option<acp::SessionId> {
2654 self.subagent_context
2655 .as_ref()
2656 .map(|c| c.parent_thread_id.clone())
2657 }
2658
2659 pub fn depth(&self) -> u8 {
2660 self.subagent_context.as_ref().map(|c| c.depth).unwrap_or(0)
2661 }
2662
2663 #[cfg(any(test, feature = "test-support"))]
2664 pub fn set_subagent_context(&mut self, context: SubagentContext) {
2665 self.subagent_context = Some(context);
2666 }
2667
2668 pub fn is_turn_complete(&self) -> bool {
2669 self.running_turn.is_none()
2670 }
2671
2672 fn build_request_messages(
2673 &self,
2674 available_tools: Vec<SharedString>,
2675 cx: &App,
2676 ) -> Vec<LanguageModelRequestMessage> {
2677 log::trace!(
2678 "Building request messages from {} thread messages",
2679 self.messages.len()
2680 );
2681
2682 let system_prompt = SystemPromptTemplate {
2683 project: self.project_context.read(cx),
2684 available_tools,
2685 model_name: self.model.as_ref().map(|m| m.name().0.to_string()),
2686 }
2687 .render(&self.templates)
2688 .context("failed to build system prompt")
2689 .expect("Invalid template");
2690 let mut messages = vec![LanguageModelRequestMessage {
2691 role: Role::System,
2692 content: vec![system_prompt.into()],
2693 cache: false,
2694 reasoning_details: None,
2695 }];
2696 for message in &self.messages {
2697 messages.extend(message.to_request());
2698 }
2699
2700 if let Some(last_message) = messages.last_mut() {
2701 last_message.cache = true;
2702 }
2703
2704 if let Some(message) = self.pending_message.as_ref() {
2705 messages.extend(message.to_request());
2706 }
2707
2708 messages
2709 }
2710
2711 pub fn to_markdown(&self) -> String {
2712 let mut markdown = String::new();
2713 for (ix, message) in self.messages.iter().enumerate() {
2714 if ix > 0 {
2715 markdown.push('\n');
2716 }
2717 match message {
2718 Message::User(_) => markdown.push_str("## User\n\n"),
2719 Message::Agent(_) => markdown.push_str("## Assistant\n\n"),
2720 Message::Resume => {}
2721 }
2722 markdown.push_str(&message.to_markdown());
2723 }
2724
2725 if let Some(message) = self.pending_message.as_ref() {
2726 markdown.push_str("\n## Assistant\n\n");
2727 markdown.push_str(&message.to_markdown());
2728 }
2729
2730 markdown
2731 }
2732
2733 fn advance_prompt_id(&mut self) {
2734 self.prompt_id = PromptId::new();
2735 }
2736
2737 fn retry_strategy_for(error: &LanguageModelCompletionError) -> Option<RetryStrategy> {
2738 use LanguageModelCompletionError::*;
2739 use http_client::StatusCode;
2740
2741 // General strategy here:
2742 // - If retrying won't help (e.g. invalid API key or payload too large), return None so we don't retry at all.
2743 // - If it's a time-based issue (e.g. server overloaded, rate limit exceeded), retry up to 4 times with exponential backoff.
2744 // - If it's an issue that *might* be fixed by retrying (e.g. internal server error), retry up to 3 times.
2745 match error {
2746 HttpResponseError {
2747 status_code: StatusCode::TOO_MANY_REQUESTS,
2748 ..
2749 } => Some(RetryStrategy::ExponentialBackoff {
2750 initial_delay: BASE_RETRY_DELAY,
2751 max_attempts: MAX_RETRY_ATTEMPTS,
2752 }),
2753 ServerOverloaded { retry_after, .. } | RateLimitExceeded { retry_after, .. } => {
2754 Some(RetryStrategy::Fixed {
2755 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
2756 max_attempts: MAX_RETRY_ATTEMPTS,
2757 })
2758 }
2759 UpstreamProviderError {
2760 status,
2761 retry_after,
2762 ..
2763 } => match *status {
2764 StatusCode::TOO_MANY_REQUESTS | StatusCode::SERVICE_UNAVAILABLE => {
2765 Some(RetryStrategy::Fixed {
2766 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
2767 max_attempts: MAX_RETRY_ATTEMPTS,
2768 })
2769 }
2770 StatusCode::INTERNAL_SERVER_ERROR => Some(RetryStrategy::Fixed {
2771 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
2772 // Internal Server Error could be anything, retry up to 3 times.
2773 max_attempts: 3,
2774 }),
2775 status => {
2776 // There is no StatusCode variant for the unofficial HTTP 529 ("The service is overloaded"),
2777 // but we frequently get them in practice. See https://http.dev/529
2778 if status.as_u16() == 529 {
2779 Some(RetryStrategy::Fixed {
2780 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
2781 max_attempts: MAX_RETRY_ATTEMPTS,
2782 })
2783 } else {
2784 Some(RetryStrategy::Fixed {
2785 delay: retry_after.unwrap_or(BASE_RETRY_DELAY),
2786 max_attempts: 2,
2787 })
2788 }
2789 }
2790 },
2791 ApiInternalServerError { .. } => Some(RetryStrategy::Fixed {
2792 delay: BASE_RETRY_DELAY,
2793 max_attempts: 3,
2794 }),
2795 ApiReadResponseError { .. }
2796 | HttpSend { .. }
2797 | DeserializeResponse { .. }
2798 | BadRequestFormat { .. } => Some(RetryStrategy::Fixed {
2799 delay: BASE_RETRY_DELAY,
2800 max_attempts: 3,
2801 }),
2802 // Retrying these errors definitely shouldn't help.
2803 HttpResponseError {
2804 status_code:
2805 StatusCode::PAYLOAD_TOO_LARGE | StatusCode::FORBIDDEN | StatusCode::UNAUTHORIZED,
2806 ..
2807 }
2808 | AuthenticationError { .. }
2809 | PermissionError { .. }
2810 | NoApiKey { .. }
2811 | ApiEndpointNotFound { .. }
2812 | PromptTooLarge { .. } => None,
2813 // These errors might be transient, so retry them
2814 SerializeRequest { .. } | BuildRequestBody { .. } | StreamEndedUnexpectedly { .. } => {
2815 Some(RetryStrategy::Fixed {
2816 delay: BASE_RETRY_DELAY,
2817 max_attempts: 1,
2818 })
2819 }
2820 // Retry all other 4xx and 5xx errors once.
2821 HttpResponseError { status_code, .. }
2822 if status_code.is_client_error() || status_code.is_server_error() =>
2823 {
2824 Some(RetryStrategy::Fixed {
2825 delay: BASE_RETRY_DELAY,
2826 max_attempts: 3,
2827 })
2828 }
2829 Other(err) if err.is::<language_model::PaymentRequiredError>() => {
2830 // Retrying won't help for Payment Required errors.
2831 None
2832 }
2833 // Conservatively assume that any other errors are non-retryable
2834 HttpResponseError { .. } | Other(..) => Some(RetryStrategy::Fixed {
2835 delay: BASE_RETRY_DELAY,
2836 max_attempts: 2,
2837 }),
2838 }
2839 }
2840}
2841
2842struct RunningTurn {
2843 /// Holds the task that handles agent interaction until the end of the turn.
2844 /// Survives across multiple requests as the model performs tool calls and
2845 /// we run tools, report their results.
2846 _task: Task<()>,
2847 /// The current event stream for the running turn. Used to report a final
2848 /// cancellation event if we cancel the turn.
2849 event_stream: ThreadEventStream,
2850 /// The tools that were enabled for this turn.
2851 tools: BTreeMap<SharedString, Arc<dyn AnyAgentTool>>,
2852 /// Sender to signal tool cancellation. When cancel is called, this is
2853 /// set to true so all tools can detect user-initiated cancellation.
2854 cancellation_tx: watch::Sender<bool>,
2855 /// Senders for tools that support input streaming and have already been
2856 /// started but are still receiving input from the LLM.
2857 streaming_tool_inputs: HashMap<LanguageModelToolUseId, ToolInputSender>,
2858}
2859
2860impl RunningTurn {
2861 fn cancel(mut self) -> Task<()> {
2862 log::debug!("Cancelling in progress turn");
2863 self.cancellation_tx.send(true).ok();
2864 self.event_stream.send_canceled();
2865 self._task
2866 }
2867}
2868
2869pub struct TokenUsageUpdated(pub Option<acp_thread::TokenUsage>);
2870
2871impl EventEmitter<TokenUsageUpdated> for Thread {}
2872
2873pub struct TitleUpdated;
2874
2875impl EventEmitter<TitleUpdated> for Thread {}
2876
2877/// A channel-based wrapper that delivers tool input to a running tool.
2878///
2879/// For non-streaming tools, created via `ToolInput::ready()` so `.recv()` resolves immediately.
2880/// For streaming tools, partial JSON snapshots arrive via `.recv_partial()` as the LLM streams
2881/// them, followed by the final complete input available through `.recv()`.
2882pub struct ToolInput<T> {
2883 partial_rx: mpsc::UnboundedReceiver<serde_json::Value>,
2884 final_rx: oneshot::Receiver<serde_json::Value>,
2885 _phantom: PhantomData<T>,
2886}
2887
2888impl<T: DeserializeOwned> ToolInput<T> {
2889 #[cfg(any(test, feature = "test-support"))]
2890 pub fn resolved(input: impl Serialize) -> Self {
2891 let value = serde_json::to_value(input).expect("failed to serialize tool input");
2892 Self::ready(value)
2893 }
2894
2895 pub fn ready(value: serde_json::Value) -> Self {
2896 let (partial_tx, partial_rx) = mpsc::unbounded();
2897 drop(partial_tx);
2898 let (final_tx, final_rx) = oneshot::channel();
2899 final_tx.send(value).ok();
2900 Self {
2901 partial_rx,
2902 final_rx,
2903 _phantom: PhantomData,
2904 }
2905 }
2906
2907 #[cfg(any(test, feature = "test-support"))]
2908 pub fn test() -> (ToolInputSender, Self) {
2909 let (sender, input) = ToolInputSender::channel();
2910 (sender, input.cast())
2911 }
2912
2913 /// Wait for the final deserialized input, ignoring all partial updates.
2914 /// Non-streaming tools can use this to wait until the whole input is available.
2915 pub async fn recv(mut self) -> Result<T> {
2916 // Drain any remaining partials
2917 while self.partial_rx.next().await.is_some() {}
2918 let value = self
2919 .final_rx
2920 .await
2921 .map_err(|_| anyhow!("tool input sender was dropped before sending final input"))?;
2922 serde_json::from_value(value).map_err(Into::into)
2923 }
2924
2925 /// Returns the next partial JSON snapshot, or `None` when input is complete.
2926 /// Once this returns `None`, call `recv()` to get the final input.
2927 pub async fn recv_partial(&mut self) -> Option<serde_json::Value> {
2928 self.partial_rx.next().await
2929 }
2930
2931 fn cast<U: DeserializeOwned>(self) -> ToolInput<U> {
2932 ToolInput {
2933 partial_rx: self.partial_rx,
2934 final_rx: self.final_rx,
2935 _phantom: PhantomData,
2936 }
2937 }
2938}
2939
2940pub struct ToolInputSender {
2941 partial_tx: mpsc::UnboundedSender<serde_json::Value>,
2942 final_tx: Option<oneshot::Sender<serde_json::Value>>,
2943}
2944
2945impl ToolInputSender {
2946 pub(crate) fn channel() -> (Self, ToolInput<serde_json::Value>) {
2947 let (partial_tx, partial_rx) = mpsc::unbounded();
2948 let (final_tx, final_rx) = oneshot::channel();
2949 let sender = Self {
2950 partial_tx,
2951 final_tx: Some(final_tx),
2952 };
2953 let input = ToolInput {
2954 partial_rx,
2955 final_rx,
2956 _phantom: PhantomData,
2957 };
2958 (sender, input)
2959 }
2960
2961 pub(crate) fn send_partial(&self, value: serde_json::Value) {
2962 self.partial_tx.unbounded_send(value).ok();
2963 }
2964
2965 pub(crate) fn send_final(mut self, value: serde_json::Value) {
2966 // Close the partial channel so recv_partial() returns None
2967 self.partial_tx.close_channel();
2968 if let Some(final_tx) = self.final_tx.take() {
2969 final_tx.send(value).ok();
2970 }
2971 }
2972}
2973
2974pub trait AgentTool
2975where
2976 Self: 'static + Sized,
2977{
2978 type Input: for<'de> Deserialize<'de> + Serialize + JsonSchema;
2979 type Output: for<'de> Deserialize<'de> + Serialize + Into<LanguageModelToolResultContent>;
2980
2981 const NAME: &'static str;
2982
2983 fn description() -> SharedString {
2984 let schema = schemars::schema_for!(Self::Input);
2985 SharedString::new(
2986 schema
2987 .get("description")
2988 .and_then(|description| description.as_str())
2989 .unwrap_or_default(),
2990 )
2991 }
2992
2993 fn kind() -> acp::ToolKind;
2994
2995 /// The initial tool title to display. Can be updated during the tool run.
2996 fn initial_title(
2997 &self,
2998 input: Result<Self::Input, serde_json::Value>,
2999 cx: &mut App,
3000 ) -> SharedString;
3001
3002 /// Returns the JSON schema that describes the tool's input.
3003 fn input_schema(format: LanguageModelToolSchemaFormat) -> Schema {
3004 language_model::tool_schema::root_schema_for::<Self::Input>(format)
3005 }
3006
3007 /// Returns whether the tool supports streaming of tool use parameters.
3008 fn supports_input_streaming() -> bool {
3009 false
3010 }
3011
3012 /// Some tools rely on a provider for the underlying billing or other reasons.
3013 /// Allow the tool to check if they are compatible, or should be filtered out.
3014 fn supports_provider(_provider: &LanguageModelProviderId) -> bool {
3015 true
3016 }
3017
3018 /// Runs the tool with the provided input.
3019 ///
3020 /// Returns `Result<Self::Output, Self::Output>` rather than `Result<Self::Output, anyhow::Error>`
3021 /// because tool errors are sent back to the model as tool results. This means error output must
3022 /// be structured and readable by the agent — not an arbitrary `anyhow::Error`. Returning the
3023 /// same `Output` type for both success and failure lets tools provide structured data while
3024 /// still signaling whether the invocation succeeded or failed.
3025 fn run(
3026 self: Arc<Self>,
3027 input: ToolInput<Self::Input>,
3028 event_stream: ToolCallEventStream,
3029 cx: &mut App,
3030 ) -> Task<Result<Self::Output, Self::Output>>;
3031
3032 /// Emits events for a previous execution of the tool.
3033 fn replay(
3034 &self,
3035 _input: Self::Input,
3036 _output: Self::Output,
3037 _event_stream: ToolCallEventStream,
3038 _cx: &mut App,
3039 ) -> Result<()> {
3040 Ok(())
3041 }
3042
3043 fn erase(self) -> Arc<dyn AnyAgentTool> {
3044 Arc::new(Erased(Arc::new(self)))
3045 }
3046}
3047
3048pub struct Erased<T>(T);
3049
3050pub struct AgentToolOutput {
3051 pub llm_output: LanguageModelToolResultContent,
3052 pub raw_output: serde_json::Value,
3053}
3054
3055impl AgentToolOutput {
3056 pub fn from_error(message: impl Into<String>) -> Self {
3057 let message = message.into();
3058 let llm_output = LanguageModelToolResultContent::Text(Arc::from(message.as_str()));
3059 Self {
3060 raw_output: serde_json::Value::String(message),
3061 llm_output,
3062 }
3063 }
3064}
3065
3066pub trait AnyAgentTool {
3067 fn name(&self) -> SharedString;
3068 fn description(&self) -> SharedString;
3069 fn kind(&self) -> acp::ToolKind;
3070 fn initial_title(&self, input: serde_json::Value, _cx: &mut App) -> SharedString;
3071 fn input_schema(&self, format: LanguageModelToolSchemaFormat) -> Result<serde_json::Value>;
3072 fn supports_input_streaming(&self) -> bool {
3073 false
3074 }
3075 fn supports_provider(&self, _provider: &LanguageModelProviderId) -> bool {
3076 true
3077 }
3078 /// See [`AgentTool::run`] for why this returns `Result<AgentToolOutput, AgentToolOutput>`.
3079 fn run(
3080 self: Arc<Self>,
3081 input: ToolInput<serde_json::Value>,
3082 event_stream: ToolCallEventStream,
3083 cx: &mut App,
3084 ) -> Task<Result<AgentToolOutput, AgentToolOutput>>;
3085 fn replay(
3086 &self,
3087 input: serde_json::Value,
3088 output: serde_json::Value,
3089 event_stream: ToolCallEventStream,
3090 cx: &mut App,
3091 ) -> Result<()>;
3092}
3093
3094impl<T> AnyAgentTool for Erased<Arc<T>>
3095where
3096 T: AgentTool,
3097{
3098 fn name(&self) -> SharedString {
3099 T::NAME.into()
3100 }
3101
3102 fn description(&self) -> SharedString {
3103 T::description()
3104 }
3105
3106 fn kind(&self) -> agent_client_protocol::ToolKind {
3107 T::kind()
3108 }
3109
3110 fn supports_input_streaming(&self) -> bool {
3111 T::supports_input_streaming()
3112 }
3113
3114 fn initial_title(&self, input: serde_json::Value, _cx: &mut App) -> SharedString {
3115 let parsed_input = serde_json::from_value(input.clone()).map_err(|_| input);
3116 self.0.initial_title(parsed_input, _cx)
3117 }
3118
3119 fn input_schema(&self, format: LanguageModelToolSchemaFormat) -> Result<serde_json::Value> {
3120 let mut json = serde_json::to_value(T::input_schema(format))?;
3121 language_model::tool_schema::adapt_schema_to_format(&mut json, format)?;
3122 Ok(json)
3123 }
3124
3125 fn supports_provider(&self, provider: &LanguageModelProviderId) -> bool {
3126 T::supports_provider(provider)
3127 }
3128
3129 fn run(
3130 self: Arc<Self>,
3131 input: ToolInput<serde_json::Value>,
3132 event_stream: ToolCallEventStream,
3133 cx: &mut App,
3134 ) -> Task<Result<AgentToolOutput, AgentToolOutput>> {
3135 let tool_input: ToolInput<T::Input> = input.cast();
3136 let task = self.0.clone().run(tool_input, event_stream, cx);
3137 cx.spawn(async move |_cx| match task.await {
3138 Ok(output) => {
3139 let raw_output = serde_json::to_value(&output).map_err(|e| {
3140 AgentToolOutput::from_error(format!("Failed to serialize tool output: {e}"))
3141 })?;
3142 Ok(AgentToolOutput {
3143 llm_output: output.into(),
3144 raw_output,
3145 })
3146 }
3147 Err(error_output) => {
3148 let raw_output = serde_json::to_value(&error_output).unwrap_or_else(|e| {
3149 log::error!("Failed to serialize tool error output: {e}");
3150 serde_json::Value::Null
3151 });
3152 Err(AgentToolOutput {
3153 llm_output: error_output.into(),
3154 raw_output,
3155 })
3156 }
3157 })
3158 }
3159
3160 fn replay(
3161 &self,
3162 input: serde_json::Value,
3163 output: serde_json::Value,
3164 event_stream: ToolCallEventStream,
3165 cx: &mut App,
3166 ) -> Result<()> {
3167 let input = serde_json::from_value(input)?;
3168 let output = serde_json::from_value(output)?;
3169 self.0.replay(input, output, event_stream, cx)
3170 }
3171}
3172
3173#[derive(Clone)]
3174struct ThreadEventStream(mpsc::UnboundedSender<Result<ThreadEvent>>);
3175
3176impl ThreadEventStream {
3177 fn send_user_message(&self, message: &UserMessage) {
3178 self.0
3179 .unbounded_send(Ok(ThreadEvent::UserMessage(message.clone())))
3180 .ok();
3181 }
3182
3183 fn send_text(&self, text: &str) {
3184 self.0
3185 .unbounded_send(Ok(ThreadEvent::AgentText(text.to_string())))
3186 .ok();
3187 }
3188
3189 fn send_thinking(&self, text: &str) {
3190 self.0
3191 .unbounded_send(Ok(ThreadEvent::AgentThinking(text.to_string())))
3192 .ok();
3193 }
3194
3195 fn send_tool_call(
3196 &self,
3197 id: &LanguageModelToolUseId,
3198 tool_name: &str,
3199 title: SharedString,
3200 kind: acp::ToolKind,
3201 input: serde_json::Value,
3202 ) {
3203 self.0
3204 .unbounded_send(Ok(ThreadEvent::ToolCall(Self::initial_tool_call(
3205 id,
3206 tool_name,
3207 title.to_string(),
3208 kind,
3209 input,
3210 ))))
3211 .ok();
3212 }
3213
3214 fn initial_tool_call(
3215 id: &LanguageModelToolUseId,
3216 tool_name: &str,
3217 title: String,
3218 kind: acp::ToolKind,
3219 input: serde_json::Value,
3220 ) -> acp::ToolCall {
3221 acp::ToolCall::new(id.to_string(), title)
3222 .kind(kind)
3223 .raw_input(input)
3224 .meta(acp_thread::meta_with_tool_name(tool_name))
3225 }
3226
3227 fn update_tool_call_fields(
3228 &self,
3229 tool_use_id: &LanguageModelToolUseId,
3230 fields: acp::ToolCallUpdateFields,
3231 meta: Option<acp::Meta>,
3232 ) {
3233 self.0
3234 .unbounded_send(Ok(ThreadEvent::ToolCallUpdate(
3235 acp::ToolCallUpdate::new(tool_use_id.to_string(), fields)
3236 .meta(meta)
3237 .into(),
3238 )))
3239 .ok();
3240 }
3241
3242 fn send_retry(&self, status: acp_thread::RetryStatus) {
3243 self.0.unbounded_send(Ok(ThreadEvent::Retry(status))).ok();
3244 }
3245
3246 fn send_stop(&self, reason: acp::StopReason) {
3247 self.0.unbounded_send(Ok(ThreadEvent::Stop(reason))).ok();
3248 }
3249
3250 fn send_canceled(&self) {
3251 self.0
3252 .unbounded_send(Ok(ThreadEvent::Stop(acp::StopReason::Cancelled)))
3253 .ok();
3254 }
3255
3256 fn send_error(&self, error: impl Into<anyhow::Error>) {
3257 self.0.unbounded_send(Err(error.into())).ok();
3258 }
3259}
3260
3261#[derive(Clone)]
3262pub struct ToolCallEventStream {
3263 tool_use_id: LanguageModelToolUseId,
3264 stream: ThreadEventStream,
3265 fs: Option<Arc<dyn Fs>>,
3266 cancellation_rx: watch::Receiver<bool>,
3267}
3268
3269impl ToolCallEventStream {
3270 #[cfg(any(test, feature = "test-support"))]
3271 pub fn test() -> (Self, ToolCallEventStreamReceiver) {
3272 let (stream, receiver, _cancellation_tx) = Self::test_with_cancellation();
3273 (stream, receiver)
3274 }
3275
3276 #[cfg(any(test, feature = "test-support"))]
3277 pub fn test_with_cancellation() -> (Self, ToolCallEventStreamReceiver, watch::Sender<bool>) {
3278 let (events_tx, events_rx) = mpsc::unbounded::<Result<ThreadEvent>>();
3279 let (cancellation_tx, cancellation_rx) = watch::channel(false);
3280
3281 let stream = ToolCallEventStream::new(
3282 "test_id".into(),
3283 ThreadEventStream(events_tx),
3284 None,
3285 cancellation_rx,
3286 );
3287
3288 (
3289 stream,
3290 ToolCallEventStreamReceiver(events_rx),
3291 cancellation_tx,
3292 )
3293 }
3294
3295 /// Signal cancellation for this event stream. Only available in tests.
3296 #[cfg(any(test, feature = "test-support"))]
3297 pub fn signal_cancellation_with_sender(cancellation_tx: &mut watch::Sender<bool>) {
3298 cancellation_tx.send(true).ok();
3299 }
3300
3301 fn new(
3302 tool_use_id: LanguageModelToolUseId,
3303 stream: ThreadEventStream,
3304 fs: Option<Arc<dyn Fs>>,
3305 cancellation_rx: watch::Receiver<bool>,
3306 ) -> Self {
3307 Self {
3308 tool_use_id,
3309 stream,
3310 fs,
3311 cancellation_rx,
3312 }
3313 }
3314
3315 /// Returns a future that resolves when the user cancels the tool call.
3316 /// Tools should select on this alongside their main work to detect user cancellation.
3317 pub fn cancelled_by_user(&self) -> impl std::future::Future<Output = ()> + '_ {
3318 let mut rx = self.cancellation_rx.clone();
3319 async move {
3320 loop {
3321 if *rx.borrow() {
3322 return;
3323 }
3324 if rx.changed().await.is_err() {
3325 // Sender dropped, will never be cancelled
3326 std::future::pending::<()>().await;
3327 }
3328 }
3329 }
3330 }
3331
3332 /// Returns true if the user has cancelled this tool call.
3333 /// This is useful for checking cancellation state after an operation completes,
3334 /// to determine if the completion was due to user cancellation.
3335 pub fn was_cancelled_by_user(&self) -> bool {
3336 *self.cancellation_rx.clone().borrow()
3337 }
3338
3339 pub fn tool_use_id(&self) -> &LanguageModelToolUseId {
3340 &self.tool_use_id
3341 }
3342
3343 pub fn update_fields(&self, fields: acp::ToolCallUpdateFields) {
3344 self.stream
3345 .update_tool_call_fields(&self.tool_use_id, fields, None);
3346 }
3347
3348 pub fn update_fields_with_meta(
3349 &self,
3350 fields: acp::ToolCallUpdateFields,
3351 meta: Option<acp::Meta>,
3352 ) {
3353 self.stream
3354 .update_tool_call_fields(&self.tool_use_id, fields, meta);
3355 }
3356
3357 pub fn update_diff(&self, diff: Entity<acp_thread::Diff>) {
3358 self.stream
3359 .0
3360 .unbounded_send(Ok(ThreadEvent::ToolCallUpdate(
3361 acp_thread::ToolCallUpdateDiff {
3362 id: acp::ToolCallId::new(self.tool_use_id.to_string()),
3363 diff,
3364 }
3365 .into(),
3366 )))
3367 .ok();
3368 }
3369
3370 pub fn subagent_spawned(&self, id: acp::SessionId) {
3371 self.stream
3372 .0
3373 .unbounded_send(Ok(ThreadEvent::SubagentSpawned(id)))
3374 .ok();
3375 }
3376
3377 /// Authorize a third-party tool (e.g., MCP tool from a context server).
3378 ///
3379 /// Unlike built-in tools, third-party tools don't support pattern-based permissions.
3380 /// They only support `default` (allow/deny/confirm) per tool.
3381 ///
3382 /// Uses the dropdown authorization flow with two granularities:
3383 /// - "Always for <display_name> MCP tool" → sets `tools.<tool_id>.default = "allow"` or "deny"
3384 /// - "Only this time" → allow/deny once
3385 pub fn authorize_third_party_tool(
3386 &self,
3387 title: impl Into<String>,
3388 tool_id: String,
3389 display_name: String,
3390 cx: &mut App,
3391 ) -> Task<Result<()>> {
3392 let settings = agent_settings::AgentSettings::get_global(cx);
3393
3394 let decision = decide_permission_from_settings(&tool_id, &[String::new()], &settings);
3395
3396 match decision {
3397 ToolPermissionDecision::Allow => return Task::ready(Ok(())),
3398 ToolPermissionDecision::Deny(reason) => return Task::ready(Err(anyhow!(reason))),
3399 ToolPermissionDecision::Confirm => {}
3400 }
3401
3402 let (response_tx, response_rx) = oneshot::channel();
3403 if let Err(error) = self
3404 .stream
3405 .0
3406 .unbounded_send(Ok(ThreadEvent::ToolCallAuthorization(
3407 ToolCallAuthorization {
3408 tool_call: acp::ToolCallUpdate::new(
3409 self.tool_use_id.to_string(),
3410 acp::ToolCallUpdateFields::new().title(title.into()),
3411 ),
3412 options: acp_thread::PermissionOptions::Dropdown(vec![
3413 acp_thread::PermissionOptionChoice {
3414 allow: acp::PermissionOption::new(
3415 acp::PermissionOptionId::new(format!(
3416 "always_allow_mcp:{}",
3417 tool_id
3418 )),
3419 format!("Always for {} MCP tool", display_name),
3420 acp::PermissionOptionKind::AllowAlways,
3421 ),
3422 deny: acp::PermissionOption::new(
3423 acp::PermissionOptionId::new(format!(
3424 "always_deny_mcp:{}",
3425 tool_id
3426 )),
3427 format!("Always for {} MCP tool", display_name),
3428 acp::PermissionOptionKind::RejectAlways,
3429 ),
3430 },
3431 acp_thread::PermissionOptionChoice {
3432 allow: acp::PermissionOption::new(
3433 acp::PermissionOptionId::new("allow"),
3434 "Only this time",
3435 acp::PermissionOptionKind::AllowOnce,
3436 ),
3437 deny: acp::PermissionOption::new(
3438 acp::PermissionOptionId::new("deny"),
3439 "Only this time",
3440 acp::PermissionOptionKind::RejectOnce,
3441 ),
3442 },
3443 ]),
3444 response: response_tx,
3445 context: None,
3446 },
3447 )))
3448 {
3449 log::error!("Failed to send tool call authorization: {error}");
3450 return Task::ready(Err(anyhow!(
3451 "Failed to send tool call authorization: {error}"
3452 )));
3453 }
3454
3455 let fs = self.fs.clone();
3456 cx.spawn(async move |cx| {
3457 let response_str = response_rx.await?.0.to_string();
3458
3459 if response_str == format!("always_allow_mcp:{}", tool_id) {
3460 if let Some(fs) = fs.clone() {
3461 cx.update(|cx| {
3462 update_settings_file(fs, cx, move |settings, _| {
3463 settings
3464 .agent
3465 .get_or_insert_default()
3466 .set_tool_default_permission(&tool_id, ToolPermissionMode::Allow);
3467 });
3468 });
3469 }
3470 return Ok(());
3471 }
3472 if response_str == format!("always_deny_mcp:{}", tool_id) {
3473 if let Some(fs) = fs.clone() {
3474 cx.update(|cx| {
3475 update_settings_file(fs, cx, move |settings, _| {
3476 settings
3477 .agent
3478 .get_or_insert_default()
3479 .set_tool_default_permission(&tool_id, ToolPermissionMode::Deny);
3480 });
3481 });
3482 }
3483 return Err(anyhow!("Permission to run tool denied by user"));
3484 }
3485
3486 if response_str == "allow" {
3487 return Ok(());
3488 }
3489
3490 Err(anyhow!("Permission to run tool denied by user"))
3491 })
3492 }
3493
3494 pub fn authorize(
3495 &self,
3496 title: impl Into<String>,
3497 context: ToolPermissionContext,
3498 cx: &mut App,
3499 ) -> Task<Result<()>> {
3500 use settings::ToolPermissionMode;
3501
3502 let options = context.build_permission_options();
3503
3504 let (response_tx, response_rx) = oneshot::channel();
3505 if let Err(error) = self
3506 .stream
3507 .0
3508 .unbounded_send(Ok(ThreadEvent::ToolCallAuthorization(
3509 ToolCallAuthorization {
3510 tool_call: acp::ToolCallUpdate::new(
3511 self.tool_use_id.to_string(),
3512 acp::ToolCallUpdateFields::new().title(title.into()),
3513 ),
3514 options,
3515 response: response_tx,
3516 context: Some(context),
3517 },
3518 )))
3519 {
3520 log::error!("Failed to send tool call authorization: {error}");
3521 return Task::ready(Err(anyhow!(
3522 "Failed to send tool call authorization: {error}"
3523 )));
3524 }
3525
3526 let fs = self.fs.clone();
3527 cx.spawn(async move |cx| {
3528 let response_str = response_rx.await?.0.to_string();
3529
3530 // Handle "always allow tool" - e.g., "always_allow:terminal"
3531 if let Some(tool) = response_str.strip_prefix("always_allow:") {
3532 if let Some(fs) = fs.clone() {
3533 let tool = tool.to_string();
3534 cx.update(|cx| {
3535 update_settings_file(fs, cx, move |settings, _| {
3536 settings
3537 .agent
3538 .get_or_insert_default()
3539 .set_tool_default_permission(&tool, ToolPermissionMode::Allow);
3540 });
3541 });
3542 }
3543 return Ok(());
3544 }
3545
3546 // Handle "always deny tool" - e.g., "always_deny:terminal"
3547 if let Some(tool) = response_str.strip_prefix("always_deny:") {
3548 if let Some(fs) = fs.clone() {
3549 let tool = tool.to_string();
3550 cx.update(|cx| {
3551 update_settings_file(fs, cx, move |settings, _| {
3552 settings
3553 .agent
3554 .get_or_insert_default()
3555 .set_tool_default_permission(&tool, ToolPermissionMode::Deny);
3556 });
3557 });
3558 }
3559 return Err(anyhow!("Permission to run tool denied by user"));
3560 }
3561
3562 // Handle "always allow pattern" - e.g., "always_allow_pattern:mcp:server:tool\n^cargo\s"
3563 if let Some(rest) = response_str.strip_prefix("always_allow_pattern:") {
3564 if let Some((pattern_tool_name, pattern)) = rest.split_once('\n') {
3565 let pattern_tool_name = pattern_tool_name.to_string();
3566 let pattern = pattern.to_string();
3567 if let Some(fs) = fs.clone() {
3568 cx.update(|cx| {
3569 update_settings_file(fs, cx, move |settings, _| {
3570 settings
3571 .agent
3572 .get_or_insert_default()
3573 .add_tool_allow_pattern(&pattern_tool_name, pattern);
3574 });
3575 });
3576 }
3577 } else {
3578 log::error!("Failed to parse always allow pattern: missing newline separator in '{rest}'");
3579 }
3580 return Ok(());
3581 }
3582
3583 // Handle "always deny pattern" - e.g., "always_deny_pattern:mcp:server:tool\n^cargo\s"
3584 if let Some(rest) = response_str.strip_prefix("always_deny_pattern:") {
3585 if let Some((pattern_tool_name, pattern)) = rest.split_once('\n') {
3586 let pattern_tool_name = pattern_tool_name.to_string();
3587 let pattern = pattern.to_string();
3588 if let Some(fs) = fs.clone() {
3589 cx.update(|cx| {
3590 update_settings_file(fs, cx, move |settings, _| {
3591 settings
3592 .agent
3593 .get_or_insert_default()
3594 .add_tool_deny_pattern(&pattern_tool_name, pattern);
3595 });
3596 });
3597 }
3598 } else {
3599 log::error!("Failed to parse always deny pattern: missing newline separator in '{rest}'");
3600 }
3601 return Err(anyhow!("Permission to run tool denied by user"));
3602 }
3603
3604 // Handle simple "allow" (allow once)
3605 if response_str == "allow" {
3606 return Ok(());
3607 }
3608
3609 // Handle simple "deny" (deny once)
3610 Err(anyhow!("Permission to run tool denied by user"))
3611 })
3612 }
3613}
3614
3615#[cfg(any(test, feature = "test-support"))]
3616pub struct ToolCallEventStreamReceiver(mpsc::UnboundedReceiver<Result<ThreadEvent>>);
3617
3618#[cfg(any(test, feature = "test-support"))]
3619impl ToolCallEventStreamReceiver {
3620 pub async fn expect_authorization(&mut self) -> ToolCallAuthorization {
3621 let event = self.0.next().await;
3622 if let Some(Ok(ThreadEvent::ToolCallAuthorization(auth))) = event {
3623 auth
3624 } else {
3625 panic!("Expected ToolCallAuthorization but got: {:?}", event);
3626 }
3627 }
3628
3629 pub async fn expect_update_fields(&mut self) -> acp::ToolCallUpdateFields {
3630 let event = self.0.next().await;
3631 if let Some(Ok(ThreadEvent::ToolCallUpdate(acp_thread::ToolCallUpdate::UpdateFields(
3632 update,
3633 )))) = event
3634 {
3635 update.fields
3636 } else {
3637 panic!("Expected update fields but got: {:?}", event);
3638 }
3639 }
3640
3641 pub async fn expect_diff(&mut self) -> Entity<acp_thread::Diff> {
3642 let event = self.0.next().await;
3643 if let Some(Ok(ThreadEvent::ToolCallUpdate(acp_thread::ToolCallUpdate::UpdateDiff(
3644 update,
3645 )))) = event
3646 {
3647 update.diff
3648 } else {
3649 panic!("Expected diff but got: {:?}", event);
3650 }
3651 }
3652
3653 pub async fn expect_terminal(&mut self) -> Entity<acp_thread::Terminal> {
3654 let event = self.0.next().await;
3655 if let Some(Ok(ThreadEvent::ToolCallUpdate(acp_thread::ToolCallUpdate::UpdateTerminal(
3656 update,
3657 )))) = event
3658 {
3659 update.terminal
3660 } else {
3661 panic!("Expected terminal but got: {:?}", event);
3662 }
3663 }
3664}
3665
3666#[cfg(any(test, feature = "test-support"))]
3667impl std::ops::Deref for ToolCallEventStreamReceiver {
3668 type Target = mpsc::UnboundedReceiver<Result<ThreadEvent>>;
3669
3670 fn deref(&self) -> &Self::Target {
3671 &self.0
3672 }
3673}
3674
3675#[cfg(any(test, feature = "test-support"))]
3676impl std::ops::DerefMut for ToolCallEventStreamReceiver {
3677 fn deref_mut(&mut self) -> &mut Self::Target {
3678 &mut self.0
3679 }
3680}
3681
3682impl From<&str> for UserMessageContent {
3683 fn from(text: &str) -> Self {
3684 Self::Text(text.into())
3685 }
3686}
3687
3688impl From<String> for UserMessageContent {
3689 fn from(text: String) -> Self {
3690 Self::Text(text)
3691 }
3692}
3693
3694impl UserMessageContent {
3695 pub fn from_content_block(value: acp::ContentBlock, path_style: PathStyle) -> Self {
3696 match value {
3697 acp::ContentBlock::Text(text_content) => Self::Text(text_content.text),
3698 acp::ContentBlock::Image(image_content) => Self::Image(convert_image(image_content)),
3699 acp::ContentBlock::Audio(_) => {
3700 // TODO
3701 Self::Text("[audio]".to_string())
3702 }
3703 acp::ContentBlock::ResourceLink(resource_link) => {
3704 match MentionUri::parse(&resource_link.uri, path_style) {
3705 Ok(uri) => Self::Mention {
3706 uri,
3707 content: String::new(),
3708 },
3709 Err(err) => {
3710 log::error!("Failed to parse mention link: {}", err);
3711 Self::Text(format!("[{}]({})", resource_link.name, resource_link.uri))
3712 }
3713 }
3714 }
3715 acp::ContentBlock::Resource(resource) => match resource.resource {
3716 acp::EmbeddedResourceResource::TextResourceContents(resource) => {
3717 match MentionUri::parse(&resource.uri, path_style) {
3718 Ok(uri) => Self::Mention {
3719 uri,
3720 content: resource.text,
3721 },
3722 Err(err) => {
3723 log::error!("Failed to parse mention link: {}", err);
3724 Self::Text(
3725 MarkdownCodeBlock {
3726 tag: &resource.uri,
3727 text: &resource.text,
3728 }
3729 .to_string(),
3730 )
3731 }
3732 }
3733 }
3734 acp::EmbeddedResourceResource::BlobResourceContents(_) => {
3735 // TODO
3736 Self::Text("[blob]".to_string())
3737 }
3738 other => {
3739 log::warn!("Unexpected content type: {:?}", other);
3740 Self::Text("[unknown]".to_string())
3741 }
3742 },
3743 other => {
3744 log::warn!("Unexpected content type: {:?}", other);
3745 Self::Text("[unknown]".to_string())
3746 }
3747 }
3748 }
3749}
3750
3751impl From<UserMessageContent> for acp::ContentBlock {
3752 fn from(content: UserMessageContent) -> Self {
3753 match content {
3754 UserMessageContent::Text(text) => text.into(),
3755 UserMessageContent::Image(image) => {
3756 acp::ContentBlock::Image(acp::ImageContent::new(image.source, "image/png"))
3757 }
3758 UserMessageContent::Mention { uri, content } => acp::ContentBlock::Resource(
3759 acp::EmbeddedResource::new(acp::EmbeddedResourceResource::TextResourceContents(
3760 acp::TextResourceContents::new(content, uri.to_uri().to_string()),
3761 )),
3762 ),
3763 }
3764 }
3765}
3766
3767fn convert_image(image_content: acp::ImageContent) -> LanguageModelImage {
3768 LanguageModelImage {
3769 source: image_content.data.into(),
3770 size: None,
3771 }
3772}
3773
3774#[cfg(test)]
3775mod tests {
3776 use super::*;
3777 use gpui::TestAppContext;
3778 use language_model::LanguageModelToolUseId;
3779 use serde_json::json;
3780 use std::sync::Arc;
3781
3782 async fn setup_thread_for_test(cx: &mut TestAppContext) -> (Entity<Thread>, ThreadEventStream) {
3783 cx.update(|cx| {
3784 let settings_store = settings::SettingsStore::test(cx);
3785 cx.set_global(settings_store);
3786 });
3787
3788 let fs = fs::FakeFs::new(cx.background_executor.clone());
3789 let templates = Templates::new();
3790 let project = Project::test(fs.clone(), [], cx).await;
3791
3792 cx.update(|cx| {
3793 let project_context = cx.new(|_cx| prompt_store::ProjectContext::default());
3794 let context_server_store = project.read(cx).context_server_store();
3795 let context_server_registry =
3796 cx.new(|cx| ContextServerRegistry::new(context_server_store, cx));
3797
3798 let thread = cx.new(|cx| {
3799 Thread::new(
3800 project,
3801 project_context,
3802 context_server_registry,
3803 templates,
3804 None,
3805 cx,
3806 )
3807 });
3808
3809 let (event_tx, _event_rx) = mpsc::unbounded();
3810 let event_stream = ThreadEventStream(event_tx);
3811
3812 (thread, event_stream)
3813 })
3814 }
3815
3816 #[gpui::test]
3817 async fn test_handle_tool_use_json_parse_error_adds_tool_use_to_content(
3818 cx: &mut TestAppContext,
3819 ) {
3820 let (thread, event_stream) = setup_thread_for_test(cx).await;
3821
3822 cx.update(|cx| {
3823 thread.update(cx, |thread, _cx| {
3824 let tool_use_id = LanguageModelToolUseId::from("test_tool_id");
3825 let tool_name: Arc<str> = Arc::from("test_tool");
3826 let raw_input: Arc<str> = Arc::from("{invalid json");
3827 let json_parse_error = "expected value at line 1 column 1".to_string();
3828
3829 // Call the function under test
3830 let result = thread.handle_tool_use_json_parse_error_event(
3831 tool_use_id.clone(),
3832 tool_name.clone(),
3833 raw_input.clone(),
3834 json_parse_error,
3835 &event_stream,
3836 );
3837
3838 // Verify the result is an error
3839 assert!(result.is_error);
3840 assert_eq!(result.tool_use_id, tool_use_id);
3841 assert_eq!(result.tool_name, tool_name);
3842 assert!(matches!(
3843 result.content,
3844 LanguageModelToolResultContent::Text(_)
3845 ));
3846
3847 // Verify the tool use was added to the message content
3848 {
3849 let last_message = thread.pending_message();
3850 assert_eq!(
3851 last_message.content.len(),
3852 1,
3853 "Should have one tool_use in content"
3854 );
3855
3856 match &last_message.content[0] {
3857 AgentMessageContent::ToolUse(tool_use) => {
3858 assert_eq!(tool_use.id, tool_use_id);
3859 assert_eq!(tool_use.name, tool_name);
3860 assert_eq!(tool_use.raw_input, raw_input.to_string());
3861 assert!(tool_use.is_input_complete);
3862 // Should fall back to empty object for invalid JSON
3863 assert_eq!(tool_use.input, json!({}));
3864 }
3865 _ => panic!("Expected ToolUse content"),
3866 }
3867 }
3868
3869 // Insert the tool result (simulating what the caller does)
3870 thread
3871 .pending_message()
3872 .tool_results
3873 .insert(result.tool_use_id.clone(), result);
3874
3875 // Verify the tool result was added
3876 let last_message = thread.pending_message();
3877 assert_eq!(
3878 last_message.tool_results.len(),
3879 1,
3880 "Should have one tool_result"
3881 );
3882 assert!(last_message.tool_results.contains_key(&tool_use_id));
3883 });
3884 });
3885 }
3886}