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
202#[derive(Debug, Clone, PartialEq, Eq)]
203pub struct AgentModelInfo {
204 pub id: acp::ModelId,
205 pub name: SharedString,
206 pub description: Option<SharedString>,
207 pub icon: Option<IconName>,
208}
209
210impl From<acp::ModelInfo> for AgentModelInfo {
211 fn from(info: acp::ModelInfo) -> Self {
212 Self {
213 id: info.model_id,
214 name: info.name.into(),
215 description: info.description.map(|desc| desc.into()),
216 icon: None,
217 }
218 }
219}
220
221#[derive(Debug, Clone, PartialEq, Eq, Hash)]
222pub struct AgentModelGroupName(pub SharedString);
223
224#[derive(Debug, Clone)]
225pub enum AgentModelList {
226 Flat(Vec<AgentModelInfo>),
227 Grouped(IndexMap<AgentModelGroupName, Vec<AgentModelInfo>>),
228}
229
230impl AgentModelList {
231 pub fn is_empty(&self) -> bool {
232 match self {
233 AgentModelList::Flat(models) => models.is_empty(),
234 AgentModelList::Grouped(groups) => groups.is_empty(),
235 }
236 }
237}
238
239#[cfg(feature = "test-support")]
240mod test_support {
241 use std::sync::Arc;
242
243 use action_log::ActionLog;
244 use collections::HashMap;
245 use futures::{channel::oneshot, future::try_join_all};
246 use gpui::{AppContext as _, WeakEntity};
247 use parking_lot::Mutex;
248
249 use super::*;
250
251 #[derive(Clone, Default)]
252 pub struct StubAgentConnection {
253 sessions: Arc<Mutex<HashMap<acp::SessionId, Session>>>,
254 permission_requests: HashMap<acp::ToolCallId, Vec<acp::PermissionOption>>,
255 next_prompt_updates: Arc<Mutex<Vec<acp::SessionUpdate>>>,
256 }
257
258 struct Session {
259 thread: WeakEntity<AcpThread>,
260 response_tx: Option<oneshot::Sender<acp::StopReason>>,
261 }
262
263 impl StubAgentConnection {
264 pub fn new() -> Self {
265 Self {
266 next_prompt_updates: Default::default(),
267 permission_requests: HashMap::default(),
268 sessions: Arc::default(),
269 }
270 }
271
272 pub fn set_next_prompt_updates(&self, updates: Vec<acp::SessionUpdate>) {
273 *self.next_prompt_updates.lock() = updates;
274 }
275
276 pub fn with_permission_requests(
277 mut self,
278 permission_requests: HashMap<acp::ToolCallId, Vec<acp::PermissionOption>>,
279 ) -> Self {
280 self.permission_requests = permission_requests;
281 self
282 }
283
284 pub fn send_update(
285 &self,
286 session_id: acp::SessionId,
287 update: acp::SessionUpdate,
288 cx: &mut App,
289 ) {
290 assert!(
291 self.next_prompt_updates.lock().is_empty(),
292 "Use either send_update or set_next_prompt_updates"
293 );
294
295 self.sessions
296 .lock()
297 .get(&session_id)
298 .unwrap()
299 .thread
300 .update(cx, |thread, cx| {
301 thread.handle_session_update(update, cx).unwrap();
302 })
303 .unwrap();
304 }
305
306 pub fn end_turn(&self, session_id: acp::SessionId, stop_reason: acp::StopReason) {
307 self.sessions
308 .lock()
309 .get_mut(&session_id)
310 .unwrap()
311 .response_tx
312 .take()
313 .expect("No pending turn")
314 .send(stop_reason)
315 .unwrap();
316 }
317 }
318
319 impl AgentConnection for StubAgentConnection {
320 fn telemetry_id(&self) -> &'static str {
321 "stub"
322 }
323
324 fn auth_methods(&self) -> &[acp::AuthMethod] {
325 &[]
326 }
327
328 fn new_thread(
329 self: Rc<Self>,
330 project: Entity<Project>,
331 _cwd: &Path,
332 cx: &mut gpui::App,
333 ) -> Task<gpui::Result<Entity<AcpThread>>> {
334 let session_id = acp::SessionId(self.sessions.lock().len().to_string().into());
335 let action_log = cx.new(|_| ActionLog::new(project.clone()));
336 let thread = cx.new(|cx| {
337 AcpThread::new(
338 "Test",
339 self.clone(),
340 project,
341 action_log,
342 session_id.clone(),
343 watch::Receiver::constant(acp::PromptCapabilities {
344 image: true,
345 audio: true,
346 embedded_context: true,
347 meta: None,
348 }),
349 cx,
350 )
351 });
352 self.sessions.lock().insert(
353 session_id,
354 Session {
355 thread: thread.downgrade(),
356 response_tx: None,
357 },
358 );
359 Task::ready(Ok(thread))
360 }
361
362 fn authenticate(
363 &self,
364 _method_id: acp::AuthMethodId,
365 _cx: &mut App,
366 ) -> Task<gpui::Result<()>> {
367 unimplemented!()
368 }
369
370 fn prompt(
371 &self,
372 _id: Option<UserMessageId>,
373 params: acp::PromptRequest,
374 cx: &mut App,
375 ) -> Task<gpui::Result<acp::PromptResponse>> {
376 let mut sessions = self.sessions.lock();
377 let Session {
378 thread,
379 response_tx,
380 } = sessions.get_mut(¶ms.session_id).unwrap();
381 let mut tasks = vec![];
382 if self.next_prompt_updates.lock().is_empty() {
383 let (tx, rx) = oneshot::channel();
384 response_tx.replace(tx);
385 cx.spawn(async move |_| {
386 let stop_reason = rx.await?;
387 Ok(acp::PromptResponse {
388 stop_reason,
389 meta: None,
390 })
391 })
392 } else {
393 for update in self.next_prompt_updates.lock().drain(..) {
394 let thread = thread.clone();
395 let update = update.clone();
396 let permission_request = if let acp::SessionUpdate::ToolCall(tool_call) =
397 &update
398 && let Some(options) = self.permission_requests.get(&tool_call.id)
399 {
400 Some((tool_call.clone(), options.clone()))
401 } else {
402 None
403 };
404 let task = cx.spawn(async move |cx| {
405 if let Some((tool_call, options)) = permission_request {
406 thread
407 .update(cx, |thread, cx| {
408 thread.request_tool_call_authorization(
409 tool_call.clone().into(),
410 options.clone(),
411 false,
412 cx,
413 )
414 })??
415 .await;
416 }
417 thread.update(cx, |thread, cx| {
418 thread.handle_session_update(update.clone(), cx).unwrap();
419 })?;
420 anyhow::Ok(())
421 });
422 tasks.push(task);
423 }
424
425 cx.spawn(async move |_| {
426 try_join_all(tasks).await?;
427 Ok(acp::PromptResponse {
428 stop_reason: acp::StopReason::EndTurn,
429 meta: None,
430 })
431 })
432 }
433 }
434
435 fn cancel(&self, session_id: &acp::SessionId, _cx: &mut App) {
436 if let Some(end_turn_tx) = self
437 .sessions
438 .lock()
439 .get_mut(session_id)
440 .unwrap()
441 .response_tx
442 .take()
443 {
444 end_turn_tx.send(acp::StopReason::Cancelled).unwrap();
445 }
446 }
447
448 fn truncate(
449 &self,
450 _session_id: &agent_client_protocol::SessionId,
451 _cx: &App,
452 ) -> Option<Rc<dyn AgentSessionTruncate>> {
453 Some(Rc::new(StubAgentSessionEditor))
454 }
455
456 fn into_any(self: Rc<Self>) -> Rc<dyn Any> {
457 self
458 }
459 }
460
461 struct StubAgentSessionEditor;
462
463 impl AgentSessionTruncate for StubAgentSessionEditor {
464 fn run(&self, _: UserMessageId, _: &mut App) -> Task<Result<()>> {
465 Task::ready(Ok(()))
466 }
467 }
468}
469
470#[cfg(feature = "test-support")]
471pub use test_support::*;