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