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