1use crate::AcpThread;
2use agent_client_protocol::{self as acp};
3use anyhow::Result;
4use collections::IndexMap;
5use gpui::{Entity, SharedString, Task};
6use language_model::LanguageModelProviderId;
7use project::Project;
8use serde::{Deserialize, Serialize};
9use std::{any::Any, error::Error, fmt, path::Path, rc::Rc, sync::Arc};
10use ui::{App, IconName};
11use uuid::Uuid;
12
13#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
14pub struct UserMessageId(Arc<str>);
15
16impl UserMessageId {
17 pub fn new() -> Self {
18 Self(Uuid::new_v4().to_string().into())
19 }
20}
21
22pub trait AgentConnection {
23 fn telemetry_id(&self) -> &'static str;
24
25 fn new_thread(
26 self: Rc<Self>,
27 project: Entity<Project>,
28 cwd: &Path,
29 cx: &mut App,
30 ) -> Task<Result<Entity<AcpThread>>>;
31
32 fn auth_methods(&self) -> &[acp::AuthMethod];
33
34 fn authenticate(&self, method: acp::AuthMethodId, cx: &mut App) -> Task<Result<()>>;
35
36 fn prompt(
37 &self,
38 user_message_id: Option<UserMessageId>,
39 params: acp::PromptRequest,
40 cx: &mut App,
41 ) -> Task<Result<acp::PromptResponse>>;
42
43 fn resume(
44 &self,
45 _session_id: &acp::SessionId,
46 _cx: &App,
47 ) -> Option<Rc<dyn AgentSessionResume>> {
48 None
49 }
50
51 fn cancel(&self, session_id: &acp::SessionId, cx: &mut App);
52
53 fn truncate(
54 &self,
55 _session_id: &acp::SessionId,
56 _cx: &App,
57 ) -> Option<Rc<dyn AgentSessionTruncate>> {
58 None
59 }
60
61 fn set_title(
62 &self,
63 _session_id: &acp::SessionId,
64 _cx: &App,
65 ) -> Option<Rc<dyn AgentSessionSetTitle>> {
66 None
67 }
68
69 /// Returns this agent as an [Rc<dyn ModelSelector>] if the model selection capability is supported.
70 ///
71 /// If the agent does not support model selection, returns [None].
72 /// This allows sharing the selector in UI components.
73 fn model_selector(&self, _session_id: &acp::SessionId) -> Option<Rc<dyn AgentModelSelector>> {
74 None
75 }
76
77 fn telemetry(&self) -> Option<Rc<dyn AgentTelemetry>> {
78 None
79 }
80
81 fn session_modes(
82 &self,
83 _session_id: &acp::SessionId,
84 _cx: &App,
85 ) -> Option<Rc<dyn AgentSessionModes>> {
86 None
87 }
88
89 fn into_any(self: Rc<Self>) -> Rc<dyn Any>;
90}
91
92impl dyn AgentConnection {
93 pub fn downcast<T: 'static + AgentConnection + Sized>(self: Rc<Self>) -> Option<Rc<T>> {
94 self.into_any().downcast().ok()
95 }
96}
97
98pub trait AgentSessionTruncate {
99 fn run(&self, message_id: UserMessageId, cx: &mut App) -> Task<Result<()>>;
100}
101
102pub trait AgentSessionResume {
103 fn run(&self, cx: &mut App) -> Task<Result<acp::PromptResponse>>;
104}
105
106pub trait AgentSessionSetTitle {
107 fn run(&self, title: SharedString, cx: &mut App) -> Task<Result<()>>;
108}
109
110pub trait AgentTelemetry {
111 /// A representation of the current thread state that can be serialized for
112 /// storage with telemetry events.
113 fn thread_data(
114 &self,
115 session_id: &acp::SessionId,
116 cx: &mut App,
117 ) -> Task<Result<serde_json::Value>>;
118}
119
120pub trait AgentSessionModes {
121 fn current_mode(&self) -> acp::SessionModeId;
122
123 fn all_modes(&self) -> Vec<acp::SessionMode>;
124
125 fn set_mode(&self, mode: acp::SessionModeId, cx: &mut App) -> Task<Result<()>>;
126}
127
128#[derive(Debug)]
129pub struct AuthRequired {
130 pub description: Option<String>,
131 pub provider_id: Option<LanguageModelProviderId>,
132}
133
134impl AuthRequired {
135 pub fn new() -> Self {
136 Self {
137 description: None,
138 provider_id: None,
139 }
140 }
141
142 pub fn with_description(mut self, description: String) -> Self {
143 self.description = Some(description);
144 self
145 }
146
147 pub fn with_language_model_provider(mut self, provider_id: LanguageModelProviderId) -> Self {
148 self.provider_id = Some(provider_id);
149 self
150 }
151}
152
153impl Error for AuthRequired {}
154impl fmt::Display for AuthRequired {
155 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
156 write!(f, "Authentication required")
157 }
158}
159
160/// Trait for agents that support listing, selecting, and querying language models.
161///
162/// This is an optional capability; agents indicate support via [AgentConnection::model_selector].
163pub trait AgentModelSelector: 'static {
164 /// Lists all available language models for this agent.
165 ///
166 /// # Parameters
167 /// - `cx`: The GPUI app context for async operations and global access.
168 ///
169 /// # Returns
170 /// A task resolving to the list of models or an error (e.g., if no models are configured).
171 fn list_models(&self, cx: &mut App) -> Task<Result<AgentModelList>>;
172
173 /// Selects a model for a specific session (thread).
174 ///
175 /// This sets the default model for future interactions in the session.
176 /// If the session doesn't exist or the model is invalid, it returns an error.
177 ///
178 /// # Parameters
179 /// - `model`: The model to select (should be one from [list_models]).
180 /// - `cx`: The GPUI app context.
181 ///
182 /// # Returns
183 /// A task resolving to `Ok(())` on success or an error.
184 fn select_model(&self, model_id: acp::ModelId, cx: &mut App) -> Task<Result<()>>;
185
186 /// Retrieves the currently selected model for a specific session (thread).
187 ///
188 /// # Parameters
189 /// - `cx`: The GPUI app context.
190 ///
191 /// # Returns
192 /// A task resolving to the selected model (always set) or an error (e.g., session not found).
193 fn selected_model(&self, cx: &mut App) -> Task<Result<AgentModelInfo>>;
194
195 /// Whenever the model list is updated the receiver will be notified.
196 /// Optional for agents that don't update their model list.
197 fn watch(&self, _cx: &mut App) -> Option<watch::Receiver<()>> {
198 None
199 }
200
201 /// Returns whether the model picker should render a footer.
202 fn should_render_footer(&self) -> bool {
203 false
204 }
205}
206
207#[derive(Debug, Clone, PartialEq, Eq)]
208pub struct AgentModelInfo {
209 pub id: acp::ModelId,
210 pub name: SharedString,
211 pub description: Option<SharedString>,
212 pub icon: Option<IconName>,
213}
214
215impl From<acp::ModelInfo> for AgentModelInfo {
216 fn from(info: acp::ModelInfo) -> Self {
217 Self {
218 id: info.model_id,
219 name: info.name.into(),
220 description: info.description.map(|desc| desc.into()),
221 icon: None,
222 }
223 }
224}
225
226#[derive(Debug, Clone, PartialEq, Eq, Hash)]
227pub struct AgentModelGroupName(pub SharedString);
228
229#[derive(Debug, Clone)]
230pub enum AgentModelList {
231 Flat(Vec<AgentModelInfo>),
232 Grouped(IndexMap<AgentModelGroupName, Vec<AgentModelInfo>>),
233}
234
235impl AgentModelList {
236 pub fn is_empty(&self) -> bool {
237 match self {
238 AgentModelList::Flat(models) => models.is_empty(),
239 AgentModelList::Grouped(groups) => groups.is_empty(),
240 }
241 }
242}
243
244#[cfg(feature = "test-support")]
245mod test_support {
246 use std::sync::Arc;
247
248 use action_log::ActionLog;
249 use collections::HashMap;
250 use futures::{channel::oneshot, future::try_join_all};
251 use gpui::{AppContext as _, WeakEntity};
252 use parking_lot::Mutex;
253
254 use super::*;
255
256 #[derive(Clone, Default)]
257 pub struct StubAgentConnection {
258 sessions: Arc<Mutex<HashMap<acp::SessionId, Session>>>,
259 permission_requests: HashMap<acp::ToolCallId, Vec<acp::PermissionOption>>,
260 next_prompt_updates: Arc<Mutex<Vec<acp::SessionUpdate>>>,
261 }
262
263 struct Session {
264 thread: WeakEntity<AcpThread>,
265 response_tx: Option<oneshot::Sender<acp::StopReason>>,
266 }
267
268 impl StubAgentConnection {
269 pub fn new() -> Self {
270 Self {
271 next_prompt_updates: Default::default(),
272 permission_requests: HashMap::default(),
273 sessions: Arc::default(),
274 }
275 }
276
277 pub fn set_next_prompt_updates(&self, updates: Vec<acp::SessionUpdate>) {
278 *self.next_prompt_updates.lock() = updates;
279 }
280
281 pub fn with_permission_requests(
282 mut self,
283 permission_requests: HashMap<acp::ToolCallId, Vec<acp::PermissionOption>>,
284 ) -> Self {
285 self.permission_requests = permission_requests;
286 self
287 }
288
289 pub fn send_update(
290 &self,
291 session_id: acp::SessionId,
292 update: acp::SessionUpdate,
293 cx: &mut App,
294 ) {
295 assert!(
296 self.next_prompt_updates.lock().is_empty(),
297 "Use either send_update or set_next_prompt_updates"
298 );
299
300 self.sessions
301 .lock()
302 .get(&session_id)
303 .unwrap()
304 .thread
305 .update(cx, |thread, cx| {
306 thread.handle_session_update(update, cx).unwrap();
307 })
308 .unwrap();
309 }
310
311 pub fn end_turn(&self, session_id: acp::SessionId, stop_reason: acp::StopReason) {
312 self.sessions
313 .lock()
314 .get_mut(&session_id)
315 .unwrap()
316 .response_tx
317 .take()
318 .expect("No pending turn")
319 .send(stop_reason)
320 .unwrap();
321 }
322 }
323
324 impl AgentConnection for StubAgentConnection {
325 fn telemetry_id(&self) -> &'static str {
326 "stub"
327 }
328
329 fn auth_methods(&self) -> &[acp::AuthMethod] {
330 &[]
331 }
332
333 fn new_thread(
334 self: Rc<Self>,
335 project: Entity<Project>,
336 _cwd: &Path,
337 cx: &mut gpui::App,
338 ) -> Task<gpui::Result<Entity<AcpThread>>> {
339 let session_id = acp::SessionId(self.sessions.lock().len().to_string().into());
340 let action_log = cx.new(|_| ActionLog::new(project.clone()));
341 let thread = cx.new(|cx| {
342 AcpThread::new(
343 "Test",
344 self.clone(),
345 project,
346 action_log,
347 session_id.clone(),
348 watch::Receiver::constant(acp::PromptCapabilities {
349 image: true,
350 audio: true,
351 embedded_context: true,
352 meta: None,
353 }),
354 cx,
355 )
356 });
357 self.sessions.lock().insert(
358 session_id,
359 Session {
360 thread: thread.downgrade(),
361 response_tx: None,
362 },
363 );
364 Task::ready(Ok(thread))
365 }
366
367 fn authenticate(
368 &self,
369 _method_id: acp::AuthMethodId,
370 _cx: &mut App,
371 ) -> Task<gpui::Result<()>> {
372 unimplemented!()
373 }
374
375 fn prompt(
376 &self,
377 _id: Option<UserMessageId>,
378 params: acp::PromptRequest,
379 cx: &mut App,
380 ) -> Task<gpui::Result<acp::PromptResponse>> {
381 let mut sessions = self.sessions.lock();
382 let Session {
383 thread,
384 response_tx,
385 } = sessions.get_mut(¶ms.session_id).unwrap();
386 let mut tasks = vec![];
387 if self.next_prompt_updates.lock().is_empty() {
388 let (tx, rx) = oneshot::channel();
389 response_tx.replace(tx);
390 cx.spawn(async move |_| {
391 let stop_reason = rx.await?;
392 Ok(acp::PromptResponse {
393 stop_reason,
394 meta: None,
395 })
396 })
397 } else {
398 for update in self.next_prompt_updates.lock().drain(..) {
399 let thread = thread.clone();
400 let update = update.clone();
401 let permission_request = if let acp::SessionUpdate::ToolCall(tool_call) =
402 &update
403 && let Some(options) = self.permission_requests.get(&tool_call.id)
404 {
405 Some((tool_call.clone(), options.clone()))
406 } else {
407 None
408 };
409 let task = cx.spawn(async move |cx| {
410 if let Some((tool_call, options)) = permission_request {
411 thread
412 .update(cx, |thread, cx| {
413 thread.request_tool_call_authorization(
414 tool_call.clone().into(),
415 options.clone(),
416 false,
417 cx,
418 )
419 })??
420 .await;
421 }
422 thread.update(cx, |thread, cx| {
423 thread.handle_session_update(update.clone(), cx).unwrap();
424 })?;
425 anyhow::Ok(())
426 });
427 tasks.push(task);
428 }
429
430 cx.spawn(async move |_| {
431 try_join_all(tasks).await?;
432 Ok(acp::PromptResponse {
433 stop_reason: acp::StopReason::EndTurn,
434 meta: None,
435 })
436 })
437 }
438 }
439
440 fn cancel(&self, session_id: &acp::SessionId, _cx: &mut App) {
441 if let Some(end_turn_tx) = self
442 .sessions
443 .lock()
444 .get_mut(session_id)
445 .unwrap()
446 .response_tx
447 .take()
448 {
449 end_turn_tx.send(acp::StopReason::Cancelled).unwrap();
450 }
451 }
452
453 fn truncate(
454 &self,
455 _session_id: &agent_client_protocol::SessionId,
456 _cx: &App,
457 ) -> Option<Rc<dyn AgentSessionTruncate>> {
458 Some(Rc::new(StubAgentSessionEditor))
459 }
460
461 fn into_any(self: Rc<Self>) -> Rc<dyn Any> {
462 self
463 }
464 }
465
466 struct StubAgentSessionEditor;
467
468 impl AgentSessionTruncate for StubAgentSessionEditor {
469 fn run(&self, _: UserMessageId, _: &mut App) -> Task<Result<()>> {
470 Task::ready(Ok(()))
471 }
472 }
473}
474
475#[cfg(feature = "test-support")]
476pub use test_support::*;