acp.rs

   1use acp_thread::{
   2    AgentConnection, AgentSessionInfo, AgentSessionList, AgentSessionListRequest,
   3    AgentSessionListResponse,
   4};
   5use acp_tools::AcpConnectionRegistry;
   6use action_log::ActionLog;
   7use agent_client_protocol::{self as acp, Agent as _, ErrorCode};
   8use anyhow::anyhow;
   9use collections::HashMap;
  10use feature_flags::{AcpBetaFeatureFlag, FeatureFlagAppExt as _};
  11use futures::AsyncBufReadExt as _;
  12use futures::io::BufReader;
  13use project::Project;
  14use project::agent_server_store::AgentServerCommand;
  15use serde::Deserialize;
  16use settings::Settings as _;
  17use task::ShellBuilder;
  18use util::ResultExt as _;
  19use util::process::Child;
  20
  21use std::path::PathBuf;
  22use std::process::Stdio;
  23use std::{any::Any, cell::RefCell};
  24use std::{path::Path, rc::Rc};
  25use thiserror::Error;
  26
  27use anyhow::{Context as _, Result};
  28use gpui::{App, AppContext as _, AsyncApp, Entity, SharedString, Task, WeakEntity};
  29
  30use acp_thread::{AcpThread, AuthRequired, LoadError, TerminalProviderEvent};
  31use terminal::TerminalBuilder;
  32use terminal::terminal_settings::{AlternateScroll, CursorShape, TerminalSettings};
  33
  34#[derive(Debug, Error)]
  35#[error("Unsupported version")]
  36pub struct UnsupportedVersion;
  37
  38pub struct AcpConnection {
  39    server_name: SharedString,
  40    telemetry_id: SharedString,
  41    connection: Rc<acp::ClientSideConnection>,
  42    sessions: Rc<RefCell<HashMap<acp::SessionId, AcpSession>>>,
  43    auth_methods: Vec<acp::AuthMethod>,
  44    agent_capabilities: acp::AgentCapabilities,
  45    default_mode: Option<acp::SessionModeId>,
  46    default_model: Option<acp::ModelId>,
  47    default_config_options: HashMap<String, String>,
  48    root_dir: PathBuf,
  49    child: Child,
  50    session_list: Option<Rc<AcpSessionList>>,
  51    _io_task: Task<Result<(), acp::Error>>,
  52    _wait_task: Task<Result<()>>,
  53    _stderr_task: Task<Result<()>>,
  54}
  55
  56struct ConfigOptions {
  57    config_options: Rc<RefCell<Vec<acp::SessionConfigOption>>>,
  58    tx: Rc<RefCell<watch::Sender<()>>>,
  59    rx: watch::Receiver<()>,
  60}
  61
  62impl ConfigOptions {
  63    fn new(config_options: Rc<RefCell<Vec<acp::SessionConfigOption>>>) -> Self {
  64        let (tx, rx) = watch::channel(());
  65        Self {
  66            config_options,
  67            tx: Rc::new(RefCell::new(tx)),
  68            rx,
  69        }
  70    }
  71}
  72
  73pub struct AcpSession {
  74    thread: WeakEntity<AcpThread>,
  75    suppress_abort_err: bool,
  76    models: Option<Rc<RefCell<acp::SessionModelState>>>,
  77    session_modes: Option<Rc<RefCell<acp::SessionModeState>>>,
  78    config_options: Option<ConfigOptions>,
  79}
  80
  81pub struct AcpSessionList {
  82    connection: Rc<acp::ClientSideConnection>,
  83    updates_tx: smol::channel::Sender<acp_thread::SessionListUpdate>,
  84    updates_rx: smol::channel::Receiver<acp_thread::SessionListUpdate>,
  85}
  86
  87impl AcpSessionList {
  88    fn new(connection: Rc<acp::ClientSideConnection>) -> Self {
  89        let (tx, rx) = smol::channel::unbounded();
  90        Self {
  91            connection,
  92            updates_tx: tx,
  93            updates_rx: rx,
  94        }
  95    }
  96
  97    fn notify_update(&self) {
  98        self.updates_tx
  99            .try_send(acp_thread::SessionListUpdate::Refresh)
 100            .log_err();
 101    }
 102
 103    fn send_info_update(&self, session_id: acp::SessionId, update: acp::SessionInfoUpdate) {
 104        self.updates_tx
 105            .try_send(acp_thread::SessionListUpdate::SessionInfo { session_id, update })
 106            .log_err();
 107    }
 108}
 109
 110impl AgentSessionList for AcpSessionList {
 111    fn list_sessions(
 112        &self,
 113        request: AgentSessionListRequest,
 114        cx: &mut App,
 115    ) -> Task<Result<AgentSessionListResponse>> {
 116        let conn = self.connection.clone();
 117        cx.foreground_executor().spawn(async move {
 118            let acp_request = acp::ListSessionsRequest::new()
 119                .cwd(request.cwd)
 120                .cursor(request.cursor);
 121            let response = conn.list_sessions(acp_request).await?;
 122            Ok(AgentSessionListResponse {
 123                sessions: response
 124                    .sessions
 125                    .into_iter()
 126                    .map(|s| AgentSessionInfo {
 127                        session_id: s.session_id,
 128                        cwd: Some(s.cwd),
 129                        title: s.title.map(Into::into),
 130                        updated_at: s.updated_at.and_then(|date_str| {
 131                            chrono::DateTime::parse_from_rfc3339(&date_str)
 132                                .ok()
 133                                .map(|dt| dt.with_timezone(&chrono::Utc))
 134                        }),
 135                        meta: s.meta,
 136                    })
 137                    .collect(),
 138                next_cursor: response.next_cursor,
 139                meta: response.meta,
 140            })
 141        })
 142    }
 143
 144    fn watch(
 145        &self,
 146        _cx: &mut App,
 147    ) -> Option<smol::channel::Receiver<acp_thread::SessionListUpdate>> {
 148        Some(self.updates_rx.clone())
 149    }
 150
 151    fn into_any(self: Rc<Self>) -> Rc<dyn Any> {
 152        self
 153    }
 154}
 155
 156pub async fn connect(
 157    server_name: SharedString,
 158    command: AgentServerCommand,
 159    root_dir: &Path,
 160    default_mode: Option<acp::SessionModeId>,
 161    default_model: Option<acp::ModelId>,
 162    default_config_options: HashMap<String, String>,
 163    is_remote: bool,
 164    cx: &mut AsyncApp,
 165) -> Result<Rc<dyn AgentConnection>> {
 166    let conn = AcpConnection::stdio(
 167        server_name,
 168        command.clone(),
 169        root_dir,
 170        default_mode,
 171        default_model,
 172        default_config_options,
 173        is_remote,
 174        cx,
 175    )
 176    .await?;
 177    Ok(Rc::new(conn) as _)
 178}
 179
 180const MINIMUM_SUPPORTED_VERSION: acp::ProtocolVersion = acp::ProtocolVersion::V1;
 181
 182impl AcpConnection {
 183    pub async fn stdio(
 184        server_name: SharedString,
 185        command: AgentServerCommand,
 186        root_dir: &Path,
 187        default_mode: Option<acp::SessionModeId>,
 188        default_model: Option<acp::ModelId>,
 189        default_config_options: HashMap<String, String>,
 190        is_remote: bool,
 191        cx: &mut AsyncApp,
 192    ) -> Result<Self> {
 193        let shell = cx.update(|cx| TerminalSettings::get(None, cx).shell.clone());
 194        let builder = ShellBuilder::new(&shell, cfg!(windows)).non_interactive();
 195        let mut child =
 196            builder.build_std_command(Some(command.path.display().to_string()), &command.args);
 197        child.envs(command.env.iter().flatten());
 198        if !is_remote {
 199            child.current_dir(root_dir);
 200        }
 201        let mut child = Child::spawn(child, Stdio::piped(), Stdio::piped(), Stdio::piped())?;
 202
 203        let stdout = child.stdout.take().context("Failed to take stdout")?;
 204        let stdin = child.stdin.take().context("Failed to take stdin")?;
 205        let stderr = child.stderr.take().context("Failed to take stderr")?;
 206        log::debug!(
 207            "Spawning external agent server: {:?}, {:?}",
 208            command.path,
 209            command.args
 210        );
 211        log::trace!("Spawned (pid: {})", child.id());
 212
 213        let sessions = Rc::new(RefCell::new(HashMap::default()));
 214
 215        let (release_channel, version): (Option<&str>, String) = cx.update(|cx| {
 216            (
 217                release_channel::ReleaseChannel::try_global(cx)
 218                    .map(|release_channel| release_channel.display_name()),
 219                release_channel::AppVersion::global(cx).to_string(),
 220            )
 221        });
 222
 223        let client_session_list: Rc<RefCell<Option<Rc<AcpSessionList>>>> =
 224            Rc::new(RefCell::new(None));
 225
 226        let client = ClientDelegate {
 227            sessions: sessions.clone(),
 228            session_list: client_session_list.clone(),
 229            cx: cx.clone(),
 230        };
 231        let (connection, io_task) = acp::ClientSideConnection::new(client, stdin, stdout, {
 232            let foreground_executor = cx.foreground_executor().clone();
 233            move |fut| {
 234                foreground_executor.spawn(fut).detach();
 235            }
 236        });
 237
 238        let io_task = cx.background_spawn(io_task);
 239
 240        let stderr_task = cx.background_spawn(async move {
 241            let mut stderr = BufReader::new(stderr);
 242            let mut line = String::new();
 243            while let Ok(n) = stderr.read_line(&mut line).await
 244                && n > 0
 245            {
 246                log::warn!("agent stderr: {}", line.trim());
 247                line.clear();
 248            }
 249            Ok(())
 250        });
 251
 252        let wait_task = cx.spawn({
 253            let sessions = sessions.clone();
 254            let status_fut = child.status();
 255            async move |cx| {
 256                let status = status_fut.await?;
 257
 258                for session in sessions.borrow().values() {
 259                    session
 260                        .thread
 261                        .update(cx, |thread, cx| {
 262                            thread.emit_load_error(LoadError::Exited { status }, cx)
 263                        })
 264                        .ok();
 265                }
 266
 267                anyhow::Ok(())
 268            }
 269        });
 270
 271        let connection = Rc::new(connection);
 272
 273        cx.update(|cx| {
 274            AcpConnectionRegistry::default_global(cx).update(cx, |registry, cx| {
 275                registry.set_active_connection(server_name.clone(), &connection, cx)
 276            });
 277        });
 278
 279        let response = connection
 280            .initialize(
 281                acp::InitializeRequest::new(acp::ProtocolVersion::V1)
 282                    .client_capabilities(
 283                        acp::ClientCapabilities::new()
 284                            .fs(acp::FileSystemCapability::new()
 285                                .read_text_file(true)
 286                                .write_text_file(true))
 287                            .terminal(true)
 288                            // Experimental: Allow for rendering terminal output from the agents
 289                            .meta(acp::Meta::from_iter([
 290                                ("terminal_output".into(), true.into()),
 291                                ("terminal-auth".into(), true.into()),
 292                            ])),
 293                    )
 294                    .client_info(
 295                        acp::Implementation::new("zed", version)
 296                            .title(release_channel.map(ToOwned::to_owned)),
 297                    ),
 298            )
 299            .await?;
 300
 301        if response.protocol_version < MINIMUM_SUPPORTED_VERSION {
 302            return Err(UnsupportedVersion.into());
 303        }
 304
 305        let telemetry_id = response
 306            .agent_info
 307            // Use the one the agent provides if we have one
 308            .map(|info| info.name.into())
 309            // Otherwise, just use the name
 310            .unwrap_or_else(|| server_name.clone());
 311
 312        let session_list = if response
 313            .agent_capabilities
 314            .session_capabilities
 315            .list
 316            .is_some()
 317        {
 318            let list = Rc::new(AcpSessionList::new(connection.clone()));
 319            *client_session_list.borrow_mut() = Some(list.clone());
 320            Some(list)
 321        } else {
 322            None
 323        };
 324
 325        Ok(Self {
 326            auth_methods: response.auth_methods,
 327            root_dir: root_dir.to_owned(),
 328            connection,
 329            server_name,
 330            telemetry_id,
 331            sessions,
 332            agent_capabilities: response.agent_capabilities,
 333            default_mode,
 334            default_model,
 335            default_config_options,
 336            session_list,
 337            _io_task: io_task,
 338            _wait_task: wait_task,
 339            _stderr_task: stderr_task,
 340            child,
 341        })
 342    }
 343
 344    pub fn prompt_capabilities(&self) -> &acp::PromptCapabilities {
 345        &self.agent_capabilities.prompt_capabilities
 346    }
 347
 348    pub fn root_dir(&self) -> &Path {
 349        &self.root_dir
 350    }
 351}
 352
 353impl Drop for AcpConnection {
 354    fn drop(&mut self) {
 355        self.child.kill().log_err();
 356    }
 357}
 358
 359impl AgentConnection for AcpConnection {
 360    fn telemetry_id(&self) -> SharedString {
 361        self.telemetry_id.clone()
 362    }
 363
 364    fn new_thread(
 365        self: Rc<Self>,
 366        project: Entity<Project>,
 367        cwd: &Path,
 368        cx: &mut App,
 369    ) -> Task<Result<Entity<AcpThread>>> {
 370        let name = self.server_name.clone();
 371        let cwd = cwd.to_path_buf();
 372        let mcp_servers = mcp_servers_for_project(&project, cx);
 373
 374        cx.spawn(async move |cx| {
 375            let response = self.connection
 376                .new_session(acp::NewSessionRequest::new(cwd).mcp_servers(mcp_servers))
 377                .await
 378                .map_err(map_acp_error)?;
 379
 380            let (modes, models, config_options) = cx.update(|cx| {
 381                config_state(cx, response.modes, response.models, response.config_options)
 382            });
 383
 384            if let Some(default_mode) = self.default_mode.clone() {
 385                if let Some(modes) = modes.as_ref() {
 386                    let mut modes_ref = modes.borrow_mut();
 387                    let has_mode = modes_ref.available_modes.iter().any(|mode| mode.id == default_mode);
 388
 389                    if has_mode {
 390                        let initial_mode_id = modes_ref.current_mode_id.clone();
 391
 392                        cx.spawn({
 393                            let default_mode = default_mode.clone();
 394                            let session_id = response.session_id.clone();
 395                            let modes = modes.clone();
 396                            let conn = self.connection.clone();
 397                            async move |_| {
 398                                let result = conn.set_session_mode(acp::SetSessionModeRequest::new(session_id, default_mode))
 399                                .await.log_err();
 400
 401                                if result.is_none() {
 402                                    modes.borrow_mut().current_mode_id = initial_mode_id;
 403                                }
 404                            }
 405                        }).detach();
 406
 407                        modes_ref.current_mode_id = default_mode;
 408                    } else {
 409                        let available_modes = modes_ref
 410                            .available_modes
 411                            .iter()
 412                            .map(|mode| format!("- `{}`: {}", mode.id, mode.name))
 413                            .collect::<Vec<_>>()
 414                            .join("\n");
 415
 416                        log::warn!(
 417                            "`{default_mode}` is not valid {name} mode. Available options:\n{available_modes}",
 418                        );
 419                    }
 420                } else {
 421                    log::warn!(
 422                        "`{name}` does not support modes, but `default_mode` was set in settings.",
 423                    );
 424                }
 425            }
 426
 427            if let Some(default_model) = self.default_model.clone() {
 428                if let Some(models) = models.as_ref() {
 429                    let mut models_ref = models.borrow_mut();
 430                    let has_model = models_ref.available_models.iter().any(|model| model.model_id == default_model);
 431
 432                    if has_model {
 433                        let initial_model_id = models_ref.current_model_id.clone();
 434
 435                        cx.spawn({
 436                            let default_model = default_model.clone();
 437                            let session_id = response.session_id.clone();
 438                            let models = models.clone();
 439                            let conn = self.connection.clone();
 440                            async move |_| {
 441                                let result = conn.set_session_model(acp::SetSessionModelRequest::new(session_id, default_model))
 442                                .await.log_err();
 443
 444                                if result.is_none() {
 445                                    models.borrow_mut().current_model_id = initial_model_id;
 446                                }
 447                            }
 448                        }).detach();
 449
 450                        models_ref.current_model_id = default_model;
 451                    } else {
 452                        let available_models = models_ref
 453                            .available_models
 454                            .iter()
 455                            .map(|model| format!("- `{}`: {}", model.model_id, model.name))
 456                            .collect::<Vec<_>>()
 457                            .join("\n");
 458
 459                        log::warn!(
 460                            "`{default_model}` is not a valid {name} model. Available options:\n{available_models}",
 461                        );
 462                    }
 463                } else {
 464                    log::warn!(
 465                        "`{name}` does not support model selection, but `default_model` was set in settings.",
 466                    );
 467                }
 468            }
 469
 470            if let Some(config_opts) = config_options.as_ref() {
 471                let defaults_to_apply: Vec<_> = {
 472                    let config_opts_ref = config_opts.borrow();
 473                    config_opts_ref
 474                        .iter()
 475                        .filter_map(|config_option| {
 476                            let default_value = self.default_config_options.get(&*config_option.id.0)?;
 477
 478                            let is_valid = match &config_option.kind {
 479                                acp::SessionConfigKind::Select(select) => match &select.options {
 480                                    acp::SessionConfigSelectOptions::Ungrouped(options) => {
 481                                        options.iter().any(|opt| &*opt.value.0 == default_value.as_str())
 482                                    }
 483                                    acp::SessionConfigSelectOptions::Grouped(groups) => groups
 484                                        .iter()
 485                                        .any(|g| g.options.iter().any(|opt| &*opt.value.0 == default_value.as_str())),
 486                                    _ => false,
 487                                },
 488                                _ => false,
 489                            };
 490
 491                            if is_valid {
 492                                let initial_value = match &config_option.kind {
 493                                    acp::SessionConfigKind::Select(select) => {
 494                                        Some(select.current_value.clone())
 495                                    }
 496                                    _ => None,
 497                                };
 498                                Some((config_option.id.clone(), default_value.clone(), initial_value))
 499                            } else {
 500                                log::warn!(
 501                                    "`{}` is not a valid value for config option `{}` in {}",
 502                                    default_value,
 503                                    config_option.id.0,
 504                                    name
 505                                );
 506                                None
 507                            }
 508                        })
 509                        .collect()
 510                };
 511
 512                for (config_id, default_value, initial_value) in defaults_to_apply {
 513                    cx.spawn({
 514                        let default_value_id = acp::SessionConfigValueId::new(default_value.clone());
 515                        let session_id = response.session_id.clone();
 516                        let config_id_clone = config_id.clone();
 517                        let config_opts = config_opts.clone();
 518                        let conn = self.connection.clone();
 519                        async move |_| {
 520                            let result = conn
 521                                .set_session_config_option(
 522                                    acp::SetSessionConfigOptionRequest::new(
 523                                        session_id,
 524                                        config_id_clone.clone(),
 525                                        default_value_id,
 526                                    ),
 527                                )
 528                                .await
 529                                .log_err();
 530
 531                            if result.is_none() {
 532                                if let Some(initial) = initial_value {
 533                                    let mut opts = config_opts.borrow_mut();
 534                                    if let Some(opt) = opts.iter_mut().find(|o| o.id == config_id_clone) {
 535                                        if let acp::SessionConfigKind::Select(select) =
 536                                            &mut opt.kind
 537                                        {
 538                                            select.current_value = initial;
 539                                        }
 540                                    }
 541                                }
 542                            }
 543                        }
 544                    })
 545                    .detach();
 546
 547                    let mut opts = config_opts.borrow_mut();
 548                    if let Some(opt) = opts.iter_mut().find(|o| o.id == config_id) {
 549                        if let acp::SessionConfigKind::Select(select) = &mut opt.kind {
 550                            select.current_value = acp::SessionConfigValueId::new(default_value);
 551                        }
 552                    }
 553                }
 554            }
 555
 556            let action_log = cx.new(|_| ActionLog::new(project.clone()));
 557            let thread: Entity<AcpThread> = cx.new(|cx| {
 558                AcpThread::new(
 559                    self.server_name.clone(),
 560                    self.clone(),
 561                    project,
 562                    action_log,
 563                    response.session_id.clone(),
 564                    // ACP doesn't currently support per-session prompt capabilities or changing capabilities dynamically.
 565                    watch::Receiver::constant(self.agent_capabilities.prompt_capabilities.clone()),
 566                    cx,
 567                )
 568            });
 569
 570            self.sessions.borrow_mut().insert(
 571                response.session_id,
 572                AcpSession {
 573                    thread: thread.downgrade(),
 574                    suppress_abort_err: false,
 575                    session_modes: modes,
 576                    models,
 577                    config_options: config_options.map(ConfigOptions::new),
 578                },
 579            );
 580
 581            if let Some(session_list) = &self.session_list {
 582                session_list.notify_update();
 583            }
 584
 585            Ok(thread)
 586        })
 587    }
 588
 589    fn supports_load_session(&self, cx: &App) -> bool {
 590        cx.has_flag::<AcpBetaFeatureFlag>() && self.agent_capabilities.load_session
 591    }
 592
 593    fn load_session(
 594        self: Rc<Self>,
 595        session: AgentSessionInfo,
 596        project: Entity<Project>,
 597        cwd: &Path,
 598        cx: &mut App,
 599    ) -> Task<Result<Entity<AcpThread>>> {
 600        if !cx.has_flag::<AcpBetaFeatureFlag>() || !self.agent_capabilities.load_session {
 601            return Task::ready(Err(anyhow!(LoadError::Other(
 602                "Loading sessions is not supported by this agent.".into()
 603            ))));
 604        }
 605
 606        let cwd = cwd.to_path_buf();
 607        let mcp_servers = mcp_servers_for_project(&project, cx);
 608        let action_log = cx.new(|_| ActionLog::new(project.clone()));
 609        let thread: Entity<AcpThread> = cx.new(|cx| {
 610            AcpThread::new(
 611                self.server_name.clone(),
 612                self.clone(),
 613                project,
 614                action_log,
 615                session.session_id.clone(),
 616                watch::Receiver::constant(self.agent_capabilities.prompt_capabilities.clone()),
 617                cx,
 618            )
 619        });
 620
 621        self.sessions.borrow_mut().insert(
 622            session.session_id.clone(),
 623            AcpSession {
 624                thread: thread.downgrade(),
 625                suppress_abort_err: false,
 626                session_modes: None,
 627                models: None,
 628                config_options: None,
 629            },
 630        );
 631
 632        cx.spawn(async move |cx| {
 633            let response = match self
 634                .connection
 635                .load_session(
 636                    acp::LoadSessionRequest::new(session.session_id.clone(), cwd)
 637                        .mcp_servers(mcp_servers),
 638                )
 639                .await
 640            {
 641                Ok(response) => response,
 642                Err(err) => {
 643                    self.sessions.borrow_mut().remove(&session.session_id);
 644                    return Err(map_acp_error(err));
 645                }
 646            };
 647
 648            let (modes, models, config_options) = cx.update(|cx| {
 649                config_state(cx, response.modes, response.models, response.config_options)
 650            });
 651            if let Some(session) = self.sessions.borrow_mut().get_mut(&session.session_id) {
 652                session.session_modes = modes;
 653                session.models = models;
 654                session.config_options = config_options.map(ConfigOptions::new);
 655            }
 656
 657            if let Some(session_list) = &self.session_list {
 658                session_list.notify_update();
 659            }
 660
 661            Ok(thread)
 662        })
 663    }
 664
 665    fn auth_methods(&self) -> &[acp::AuthMethod] {
 666        &self.auth_methods
 667    }
 668
 669    fn authenticate(&self, method_id: acp::AuthMethodId, cx: &mut App) -> Task<Result<()>> {
 670        let conn = self.connection.clone();
 671        cx.foreground_executor().spawn(async move {
 672            conn.authenticate(acp::AuthenticateRequest::new(method_id))
 673                .await?;
 674            Ok(())
 675        })
 676    }
 677
 678    fn prompt(
 679        &self,
 680        _id: Option<acp_thread::UserMessageId>,
 681        params: acp::PromptRequest,
 682        cx: &mut App,
 683    ) -> Task<Result<acp::PromptResponse>> {
 684        let conn = self.connection.clone();
 685        let sessions = self.sessions.clone();
 686        let session_id = params.session_id.clone();
 687        cx.foreground_executor().spawn(async move {
 688            let result = conn.prompt(params).await;
 689
 690            let mut suppress_abort_err = false;
 691
 692            if let Some(session) = sessions.borrow_mut().get_mut(&session_id) {
 693                suppress_abort_err = session.suppress_abort_err;
 694                session.suppress_abort_err = false;
 695            }
 696
 697            match result {
 698                Ok(response) => Ok(response),
 699                Err(err) => {
 700                    if err.code == acp::ErrorCode::AuthRequired {
 701                        return Err(anyhow!(acp::Error::auth_required()));
 702                    }
 703
 704                    if err.code != ErrorCode::InternalError {
 705                        anyhow::bail!(err)
 706                    }
 707
 708                    let Some(data) = &err.data else {
 709                        anyhow::bail!(err)
 710                    };
 711
 712                    // Temporary workaround until the following PR is generally available:
 713                    // https://github.com/google-gemini/gemini-cli/pull/6656
 714
 715                    #[derive(Deserialize)]
 716                    #[serde(deny_unknown_fields)]
 717                    struct ErrorDetails {
 718                        details: Box<str>,
 719                    }
 720
 721                    match serde_json::from_value(data.clone()) {
 722                        Ok(ErrorDetails { details }) => {
 723                            if suppress_abort_err
 724                                && (details.contains("This operation was aborted")
 725                                    || details.contains("The user aborted a request"))
 726                            {
 727                                Ok(acp::PromptResponse::new(acp::StopReason::Cancelled))
 728                            } else {
 729                                Err(anyhow!(details))
 730                            }
 731                        }
 732                        Err(_) => Err(anyhow!(err)),
 733                    }
 734                }
 735            }
 736        })
 737    }
 738
 739    fn cancel(&self, session_id: &acp::SessionId, cx: &mut App) {
 740        if let Some(session) = self.sessions.borrow_mut().get_mut(session_id) {
 741            session.suppress_abort_err = true;
 742        }
 743        let conn = self.connection.clone();
 744        let params = acp::CancelNotification::new(session_id.clone());
 745        cx.foreground_executor()
 746            .spawn(async move { conn.cancel(params).await })
 747            .detach();
 748    }
 749
 750    fn session_modes(
 751        &self,
 752        session_id: &acp::SessionId,
 753        _cx: &App,
 754    ) -> Option<Rc<dyn acp_thread::AgentSessionModes>> {
 755        let sessions = self.sessions.clone();
 756        let sessions_ref = sessions.borrow();
 757        let Some(session) = sessions_ref.get(session_id) else {
 758            return None;
 759        };
 760
 761        if let Some(modes) = session.session_modes.as_ref() {
 762            Some(Rc::new(AcpSessionModes {
 763                connection: self.connection.clone(),
 764                session_id: session_id.clone(),
 765                state: modes.clone(),
 766            }) as _)
 767        } else {
 768            None
 769        }
 770    }
 771
 772    fn model_selector(
 773        &self,
 774        session_id: &acp::SessionId,
 775    ) -> Option<Rc<dyn acp_thread::AgentModelSelector>> {
 776        let sessions = self.sessions.clone();
 777        let sessions_ref = sessions.borrow();
 778        let Some(session) = sessions_ref.get(session_id) else {
 779            return None;
 780        };
 781
 782        if let Some(models) = session.models.as_ref() {
 783            Some(Rc::new(AcpModelSelector::new(
 784                session_id.clone(),
 785                self.connection.clone(),
 786                models.clone(),
 787            )) as _)
 788        } else {
 789            None
 790        }
 791    }
 792
 793    fn session_config_options(
 794        &self,
 795        session_id: &acp::SessionId,
 796        _cx: &App,
 797    ) -> Option<Rc<dyn acp_thread::AgentSessionConfigOptions>> {
 798        let sessions = self.sessions.borrow();
 799        let session = sessions.get(session_id)?;
 800
 801        let config_opts = session.config_options.as_ref()?;
 802
 803        Some(Rc::new(AcpSessionConfigOptions {
 804            session_id: session_id.clone(),
 805            connection: self.connection.clone(),
 806            state: config_opts.config_options.clone(),
 807            watch_tx: config_opts.tx.clone(),
 808            watch_rx: config_opts.rx.clone(),
 809        }) as _)
 810    }
 811
 812    fn session_list(&self, cx: &mut App) -> Option<Rc<dyn AgentSessionList>> {
 813        if cx.has_flag::<AcpBetaFeatureFlag>() {
 814            self.session_list.clone().map(|s| s as _)
 815        } else {
 816            None
 817        }
 818    }
 819
 820    fn into_any(self: Rc<Self>) -> Rc<dyn Any> {
 821        self
 822    }
 823}
 824
 825fn map_acp_error(err: acp::Error) -> anyhow::Error {
 826    if err.code == acp::ErrorCode::AuthRequired {
 827        let mut error = AuthRequired::new();
 828
 829        if err.message != acp::ErrorCode::AuthRequired.to_string() {
 830            error = error.with_description(err.message);
 831        }
 832
 833        anyhow!(error)
 834    } else {
 835        anyhow!(err)
 836    }
 837}
 838
 839fn mcp_servers_for_project(project: &Entity<Project>, cx: &App) -> Vec<acp::McpServer> {
 840    let context_server_store = project.read(cx).context_server_store().read(cx);
 841    let is_local = project.read(cx).is_local();
 842    context_server_store
 843        .configured_server_ids()
 844        .iter()
 845        .filter_map(|id| {
 846            let configuration = context_server_store.configuration_for_server(id)?;
 847            match &*configuration {
 848                project::context_server_store::ContextServerConfiguration::Custom {
 849                    command,
 850                    remote,
 851                    ..
 852                }
 853                | project::context_server_store::ContextServerConfiguration::Extension {
 854                    command,
 855                    remote,
 856                    ..
 857                } if is_local || *remote => Some(acp::McpServer::Stdio(
 858                    acp::McpServerStdio::new(id.0.to_string(), &command.path)
 859                        .args(command.args.clone())
 860                        .env(if let Some(env) = command.env.as_ref() {
 861                            env.iter()
 862                                .map(|(name, value)| acp::EnvVariable::new(name, value))
 863                                .collect()
 864                        } else {
 865                            vec![]
 866                        }),
 867                )),
 868                project::context_server_store::ContextServerConfiguration::Http {
 869                    url,
 870                    headers,
 871                    timeout: _,
 872                } => Some(acp::McpServer::Http(
 873                    acp::McpServerHttp::new(id.0.to_string(), url.to_string()).headers(
 874                        headers
 875                            .iter()
 876                            .map(|(name, value)| acp::HttpHeader::new(name, value))
 877                            .collect(),
 878                    ),
 879                )),
 880                _ => None,
 881            }
 882        })
 883        .collect()
 884}
 885
 886fn config_state(
 887    cx: &App,
 888    modes: Option<acp::SessionModeState>,
 889    models: Option<acp::SessionModelState>,
 890    config_options: Option<Vec<acp::SessionConfigOption>>,
 891) -> (
 892    Option<Rc<RefCell<acp::SessionModeState>>>,
 893    Option<Rc<RefCell<acp::SessionModelState>>>,
 894    Option<Rc<RefCell<Vec<acp::SessionConfigOption>>>>,
 895) {
 896    if cx.has_flag::<AcpBetaFeatureFlag>()
 897        && let Some(opts) = config_options
 898    {
 899        return (None, None, Some(Rc::new(RefCell::new(opts))));
 900    }
 901
 902    let modes = modes.map(|modes| Rc::new(RefCell::new(modes)));
 903    let models = models.map(|models| Rc::new(RefCell::new(models)));
 904    (modes, models, None)
 905}
 906
 907struct AcpSessionModes {
 908    session_id: acp::SessionId,
 909    connection: Rc<acp::ClientSideConnection>,
 910    state: Rc<RefCell<acp::SessionModeState>>,
 911}
 912
 913impl acp_thread::AgentSessionModes for AcpSessionModes {
 914    fn current_mode(&self) -> acp::SessionModeId {
 915        self.state.borrow().current_mode_id.clone()
 916    }
 917
 918    fn all_modes(&self) -> Vec<acp::SessionMode> {
 919        self.state.borrow().available_modes.clone()
 920    }
 921
 922    fn set_mode(&self, mode_id: acp::SessionModeId, cx: &mut App) -> Task<Result<()>> {
 923        let connection = self.connection.clone();
 924        let session_id = self.session_id.clone();
 925        let old_mode_id;
 926        {
 927            let mut state = self.state.borrow_mut();
 928            old_mode_id = state.current_mode_id.clone();
 929            state.current_mode_id = mode_id.clone();
 930        };
 931        let state = self.state.clone();
 932        cx.foreground_executor().spawn(async move {
 933            let result = connection
 934                .set_session_mode(acp::SetSessionModeRequest::new(session_id, mode_id))
 935                .await;
 936
 937            if result.is_err() {
 938                state.borrow_mut().current_mode_id = old_mode_id;
 939            }
 940
 941            result?;
 942
 943            Ok(())
 944        })
 945    }
 946}
 947
 948struct AcpModelSelector {
 949    session_id: acp::SessionId,
 950    connection: Rc<acp::ClientSideConnection>,
 951    state: Rc<RefCell<acp::SessionModelState>>,
 952}
 953
 954impl AcpModelSelector {
 955    fn new(
 956        session_id: acp::SessionId,
 957        connection: Rc<acp::ClientSideConnection>,
 958        state: Rc<RefCell<acp::SessionModelState>>,
 959    ) -> Self {
 960        Self {
 961            session_id,
 962            connection,
 963            state,
 964        }
 965    }
 966}
 967
 968impl acp_thread::AgentModelSelector for AcpModelSelector {
 969    fn list_models(&self, _cx: &mut App) -> Task<Result<acp_thread::AgentModelList>> {
 970        Task::ready(Ok(acp_thread::AgentModelList::Flat(
 971            self.state
 972                .borrow()
 973                .available_models
 974                .clone()
 975                .into_iter()
 976                .map(acp_thread::AgentModelInfo::from)
 977                .collect(),
 978        )))
 979    }
 980
 981    fn select_model(&self, model_id: acp::ModelId, cx: &mut App) -> Task<Result<()>> {
 982        let connection = self.connection.clone();
 983        let session_id = self.session_id.clone();
 984        let old_model_id;
 985        {
 986            let mut state = self.state.borrow_mut();
 987            old_model_id = state.current_model_id.clone();
 988            state.current_model_id = model_id.clone();
 989        };
 990        let state = self.state.clone();
 991        cx.foreground_executor().spawn(async move {
 992            let result = connection
 993                .set_session_model(acp::SetSessionModelRequest::new(session_id, model_id))
 994                .await;
 995
 996            if result.is_err() {
 997                state.borrow_mut().current_model_id = old_model_id;
 998            }
 999
1000            result?;
1001
1002            Ok(())
1003        })
1004    }
1005
1006    fn selected_model(&self, _cx: &mut App) -> Task<Result<acp_thread::AgentModelInfo>> {
1007        let state = self.state.borrow();
1008        Task::ready(
1009            state
1010                .available_models
1011                .iter()
1012                .find(|m| m.model_id == state.current_model_id)
1013                .cloned()
1014                .map(acp_thread::AgentModelInfo::from)
1015                .ok_or_else(|| anyhow::anyhow!("Model not found")),
1016        )
1017    }
1018}
1019
1020struct AcpSessionConfigOptions {
1021    session_id: acp::SessionId,
1022    connection: Rc<acp::ClientSideConnection>,
1023    state: Rc<RefCell<Vec<acp::SessionConfigOption>>>,
1024    watch_tx: Rc<RefCell<watch::Sender<()>>>,
1025    watch_rx: watch::Receiver<()>,
1026}
1027
1028impl acp_thread::AgentSessionConfigOptions for AcpSessionConfigOptions {
1029    fn config_options(&self) -> Vec<acp::SessionConfigOption> {
1030        self.state.borrow().clone()
1031    }
1032
1033    fn set_config_option(
1034        &self,
1035        config_id: acp::SessionConfigId,
1036        value: acp::SessionConfigValueId,
1037        cx: &mut App,
1038    ) -> Task<Result<Vec<acp::SessionConfigOption>>> {
1039        let connection = self.connection.clone();
1040        let session_id = self.session_id.clone();
1041        let state = self.state.clone();
1042
1043        let watch_tx = self.watch_tx.clone();
1044
1045        cx.foreground_executor().spawn(async move {
1046            let response = connection
1047                .set_session_config_option(acp::SetSessionConfigOptionRequest::new(
1048                    session_id, config_id, value,
1049                ))
1050                .await?;
1051
1052            *state.borrow_mut() = response.config_options.clone();
1053            watch_tx.borrow_mut().send(()).ok();
1054            Ok(response.config_options)
1055        })
1056    }
1057
1058    fn watch(&self, _cx: &mut App) -> Option<watch::Receiver<()>> {
1059        Some(self.watch_rx.clone())
1060    }
1061}
1062
1063struct ClientDelegate {
1064    sessions: Rc<RefCell<HashMap<acp::SessionId, AcpSession>>>,
1065    session_list: Rc<RefCell<Option<Rc<AcpSessionList>>>>,
1066    cx: AsyncApp,
1067}
1068
1069#[async_trait::async_trait(?Send)]
1070impl acp::Client for ClientDelegate {
1071    async fn request_permission(
1072        &self,
1073        arguments: acp::RequestPermissionRequest,
1074    ) -> Result<acp::RequestPermissionResponse, acp::Error> {
1075        let respect_always_allow_setting;
1076        let thread;
1077        {
1078            let sessions_ref = self.sessions.borrow();
1079            let session = sessions_ref
1080                .get(&arguments.session_id)
1081                .context("Failed to get session")?;
1082            respect_always_allow_setting = session.session_modes.is_none();
1083            thread = session.thread.clone();
1084        }
1085
1086        let cx = &mut self.cx.clone();
1087
1088        let task = thread.update(cx, |thread, cx| {
1089            thread.request_tool_call_authorization(
1090                arguments.tool_call,
1091                acp_thread::PermissionOptions::Flat(arguments.options),
1092                respect_always_allow_setting,
1093                cx,
1094            )
1095        })??;
1096
1097        let outcome = task.await;
1098
1099        Ok(acp::RequestPermissionResponse::new(outcome))
1100    }
1101
1102    async fn write_text_file(
1103        &self,
1104        arguments: acp::WriteTextFileRequest,
1105    ) -> Result<acp::WriteTextFileResponse, acp::Error> {
1106        let cx = &mut self.cx.clone();
1107        let task = self
1108            .session_thread(&arguments.session_id)?
1109            .update(cx, |thread, cx| {
1110                thread.write_text_file(arguments.path, arguments.content, cx)
1111            })?;
1112
1113        task.await?;
1114
1115        Ok(Default::default())
1116    }
1117
1118    async fn read_text_file(
1119        &self,
1120        arguments: acp::ReadTextFileRequest,
1121    ) -> Result<acp::ReadTextFileResponse, acp::Error> {
1122        let task = self.session_thread(&arguments.session_id)?.update(
1123            &mut self.cx.clone(),
1124            |thread, cx| {
1125                thread.read_text_file(arguments.path, arguments.line, arguments.limit, false, cx)
1126            },
1127        )?;
1128
1129        let content = task.await?;
1130
1131        Ok(acp::ReadTextFileResponse::new(content))
1132    }
1133
1134    async fn session_notification(
1135        &self,
1136        notification: acp::SessionNotification,
1137    ) -> Result<(), acp::Error> {
1138        let sessions = self.sessions.borrow();
1139        let session = sessions
1140            .get(&notification.session_id)
1141            .context("Failed to get session")?;
1142
1143        if let acp::SessionUpdate::CurrentModeUpdate(acp::CurrentModeUpdate {
1144            current_mode_id,
1145            ..
1146        }) = &notification.update
1147        {
1148            if let Some(session_modes) = &session.session_modes {
1149                session_modes.borrow_mut().current_mode_id = current_mode_id.clone();
1150            } else {
1151                log::error!(
1152                    "Got a `CurrentModeUpdate` notification, but they agent didn't specify `modes` during setting setup."
1153                );
1154            }
1155        }
1156
1157        if let acp::SessionUpdate::ConfigOptionUpdate(acp::ConfigOptionUpdate {
1158            config_options,
1159            ..
1160        }) = &notification.update
1161        {
1162            if let Some(opts) = &session.config_options {
1163                *opts.config_options.borrow_mut() = config_options.clone();
1164                opts.tx.borrow_mut().send(()).ok();
1165            } else {
1166                log::error!(
1167                    "Got a `ConfigOptionUpdate` notification, but the agent didn't specify `config_options` during session setup."
1168                );
1169            }
1170        }
1171
1172        if let acp::SessionUpdate::SessionInfoUpdate(info_update) = &notification.update
1173            && let Some(session_list) = self.session_list.borrow().as_ref()
1174        {
1175            session_list.send_info_update(notification.session_id.clone(), info_update.clone());
1176        }
1177
1178        // Clone so we can inspect meta both before and after handing off to the thread
1179        let update_clone = notification.update.clone();
1180
1181        // Pre-handle: if a ToolCall carries terminal_info, create/register a display-only terminal.
1182        if let acp::SessionUpdate::ToolCall(tc) = &update_clone {
1183            if let Some(meta) = &tc.meta {
1184                if let Some(terminal_info) = meta.get("terminal_info") {
1185                    if let Some(id_str) = terminal_info.get("terminal_id").and_then(|v| v.as_str())
1186                    {
1187                        let terminal_id = acp::TerminalId::new(id_str);
1188                        let cwd = terminal_info
1189                            .get("cwd")
1190                            .and_then(|v| v.as_str().map(PathBuf::from));
1191
1192                        // Create a minimal display-only lower-level terminal and register it.
1193                        let _ = session.thread.update(&mut self.cx.clone(), |thread, cx| {
1194                            let builder = TerminalBuilder::new_display_only(
1195                                CursorShape::default(),
1196                                AlternateScroll::On,
1197                                None,
1198                                0,
1199                            )?;
1200                            let lower = cx.new(|cx| builder.subscribe(cx));
1201                            thread.on_terminal_provider_event(
1202                                TerminalProviderEvent::Created {
1203                                    terminal_id,
1204                                    label: tc.title.clone(),
1205                                    cwd,
1206                                    output_byte_limit: None,
1207                                    terminal: lower,
1208                                },
1209                                cx,
1210                            );
1211                            anyhow::Ok(())
1212                        });
1213                    }
1214                }
1215            }
1216        }
1217
1218        // Forward the update to the acp_thread as usual.
1219        session.thread.update(&mut self.cx.clone(), |thread, cx| {
1220            thread.handle_session_update(notification.update.clone(), cx)
1221        })??;
1222
1223        // Post-handle: stream terminal output/exit if present on ToolCallUpdate meta.
1224        if let acp::SessionUpdate::ToolCallUpdate(tcu) = &update_clone {
1225            if let Some(meta) = &tcu.meta {
1226                if let Some(term_out) = meta.get("terminal_output") {
1227                    if let Some(id_str) = term_out.get("terminal_id").and_then(|v| v.as_str()) {
1228                        let terminal_id = acp::TerminalId::new(id_str);
1229                        if let Some(s) = term_out.get("data").and_then(|v| v.as_str()) {
1230                            let data = s.as_bytes().to_vec();
1231                            let _ = session.thread.update(&mut self.cx.clone(), |thread, cx| {
1232                                thread.on_terminal_provider_event(
1233                                    TerminalProviderEvent::Output { terminal_id, data },
1234                                    cx,
1235                                );
1236                            });
1237                        }
1238                    }
1239                }
1240
1241                // terminal_exit
1242                if let Some(term_exit) = meta.get("terminal_exit") {
1243                    if let Some(id_str) = term_exit.get("terminal_id").and_then(|v| v.as_str()) {
1244                        let terminal_id = acp::TerminalId::new(id_str);
1245                        let status = acp::TerminalExitStatus::new()
1246                            .exit_code(
1247                                term_exit
1248                                    .get("exit_code")
1249                                    .and_then(|v| v.as_u64())
1250                                    .map(|i| i as u32),
1251                            )
1252                            .signal(
1253                                term_exit
1254                                    .get("signal")
1255                                    .and_then(|v| v.as_str().map(|s| s.to_string())),
1256                            );
1257
1258                        let _ = session.thread.update(&mut self.cx.clone(), |thread, cx| {
1259                            thread.on_terminal_provider_event(
1260                                TerminalProviderEvent::Exit {
1261                                    terminal_id,
1262                                    status,
1263                                },
1264                                cx,
1265                            );
1266                        });
1267                    }
1268                }
1269            }
1270        }
1271
1272        Ok(())
1273    }
1274
1275    async fn create_terminal(
1276        &self,
1277        args: acp::CreateTerminalRequest,
1278    ) -> Result<acp::CreateTerminalResponse, acp::Error> {
1279        let thread = self.session_thread(&args.session_id)?;
1280        let project = thread.read_with(&self.cx, |thread, _cx| thread.project().clone())?;
1281
1282        let terminal_entity = acp_thread::create_terminal_entity(
1283            args.command.clone(),
1284            &args.args,
1285            args.env
1286                .into_iter()
1287                .map(|env| (env.name, env.value))
1288                .collect(),
1289            args.cwd.clone(),
1290            &project,
1291            &mut self.cx.clone(),
1292        )
1293        .await?;
1294
1295        // Register with renderer
1296        let terminal_entity = thread.update(&mut self.cx.clone(), |thread, cx| {
1297            thread.register_terminal_created(
1298                acp::TerminalId::new(uuid::Uuid::new_v4().to_string()),
1299                format!("{} {}", args.command, args.args.join(" ")),
1300                args.cwd.clone(),
1301                args.output_byte_limit,
1302                terminal_entity,
1303                cx,
1304            )
1305        })?;
1306        let terminal_id = terminal_entity.read_with(&self.cx, |terminal, _| terminal.id().clone());
1307        Ok(acp::CreateTerminalResponse::new(terminal_id))
1308    }
1309
1310    async fn kill_terminal_command(
1311        &self,
1312        args: acp::KillTerminalCommandRequest,
1313    ) -> Result<acp::KillTerminalCommandResponse, acp::Error> {
1314        self.session_thread(&args.session_id)?
1315            .update(&mut self.cx.clone(), |thread, cx| {
1316                thread.kill_terminal(args.terminal_id, cx)
1317            })??;
1318
1319        Ok(Default::default())
1320    }
1321
1322    async fn ext_method(&self, _args: acp::ExtRequest) -> Result<acp::ExtResponse, acp::Error> {
1323        Err(acp::Error::method_not_found())
1324    }
1325
1326    async fn ext_notification(&self, _args: acp::ExtNotification) -> Result<(), acp::Error> {
1327        Err(acp::Error::method_not_found())
1328    }
1329
1330    async fn release_terminal(
1331        &self,
1332        args: acp::ReleaseTerminalRequest,
1333    ) -> Result<acp::ReleaseTerminalResponse, acp::Error> {
1334        self.session_thread(&args.session_id)?
1335            .update(&mut self.cx.clone(), |thread, cx| {
1336                thread.release_terminal(args.terminal_id, cx)
1337            })??;
1338
1339        Ok(Default::default())
1340    }
1341
1342    async fn terminal_output(
1343        &self,
1344        args: acp::TerminalOutputRequest,
1345    ) -> Result<acp::TerminalOutputResponse, acp::Error> {
1346        self.session_thread(&args.session_id)?
1347            .read_with(&mut self.cx.clone(), |thread, cx| {
1348                let out = thread
1349                    .terminal(args.terminal_id)?
1350                    .read(cx)
1351                    .current_output(cx);
1352
1353                Ok(out)
1354            })?
1355    }
1356
1357    async fn wait_for_terminal_exit(
1358        &self,
1359        args: acp::WaitForTerminalExitRequest,
1360    ) -> Result<acp::WaitForTerminalExitResponse, acp::Error> {
1361        let exit_status = self
1362            .session_thread(&args.session_id)?
1363            .update(&mut self.cx.clone(), |thread, cx| {
1364                anyhow::Ok(thread.terminal(args.terminal_id)?.read(cx).wait_for_exit())
1365            })??
1366            .await;
1367
1368        Ok(acp::WaitForTerminalExitResponse::new(exit_status))
1369    }
1370}
1371
1372impl ClientDelegate {
1373    fn session_thread(&self, session_id: &acp::SessionId) -> Result<WeakEntity<AcpThread>> {
1374        let sessions = self.sessions.borrow();
1375        sessions
1376            .get(session_id)
1377            .context("Failed to get session")
1378            .map(|session| session.thread.clone())
1379    }
1380}