custom.rs

  1use crate::{AgentServerDelegate, load_proxy_env};
  2use acp_thread::AgentConnection;
  3use agent_client_protocol as acp;
  4use anyhow::{Context as _, Result};
  5use fs::Fs;
  6use gpui::{App, AppContext as _, SharedString, Task};
  7use project::agent_server_store::{AllAgentServersSettings, ExternalAgentServerName};
  8use settings::{SettingsStore, update_settings_file};
  9use std::{path::Path, rc::Rc, sync::Arc};
 10use ui::IconName;
 11
 12/// A generic agent server implementation for custom user-defined agents
 13pub struct CustomAgentServer {
 14    name: SharedString,
 15}
 16
 17impl CustomAgentServer {
 18    pub fn new(name: SharedString) -> Self {
 19        Self { name }
 20    }
 21}
 22
 23impl crate::AgentServer for CustomAgentServer {
 24    fn telemetry_id(&self) -> &'static str {
 25        "custom"
 26    }
 27
 28    fn name(&self) -> SharedString {
 29        self.name.clone()
 30    }
 31
 32    fn logo(&self) -> IconName {
 33        IconName::Terminal
 34    }
 35
 36    fn default_mode(&self, cx: &mut App) -> Option<acp::SessionModeId> {
 37        let settings = cx.read_global(|settings: &SettingsStore, _| {
 38            settings
 39                .get::<AllAgentServersSettings>(None)
 40                .custom
 41                .get(&self.name())
 42                .cloned()
 43        });
 44
 45        settings
 46            .as_ref()
 47            .and_then(|s| s.default_mode.clone().map(|m| acp::SessionModeId(m.into())))
 48    }
 49
 50    fn set_default_mode(&self, mode_id: Option<acp::SessionModeId>, fs: Arc<dyn Fs>, cx: &mut App) {
 51        let name = self.name();
 52        update_settings_file(fs, cx, move |settings, _| {
 53            settings
 54                .agent_servers
 55                .get_or_insert_default()
 56                .custom
 57                .get_mut(&name)
 58                .unwrap()
 59                .default_mode = mode_id.map(|m| m.to_string())
 60        });
 61    }
 62
 63    fn connect(
 64        &self,
 65        root_dir: Option<&Path>,
 66        delegate: AgentServerDelegate,
 67        cx: &mut App,
 68    ) -> Task<Result<(Rc<dyn AgentConnection>, Option<task::SpawnInTerminal>)>> {
 69        let name = self.name();
 70        let root_dir = root_dir.map(|root_dir| root_dir.to_string_lossy().into_owned());
 71        let is_remote = delegate.project.read(cx).is_via_remote_server();
 72        let default_mode = self.default_mode(cx);
 73        let store = delegate.store.downgrade();
 74        let extra_env = load_proxy_env(cx);
 75
 76        cx.spawn(async move |cx| {
 77            let (command, root_dir, login) = store
 78                .update(cx, |store, cx| {
 79                    let agent = store
 80                        .get_external_agent(&ExternalAgentServerName(name.clone()))
 81                        .with_context(|| {
 82                            format!("Custom agent server `{}` is not registered", name)
 83                        })?;
 84                    anyhow::Ok(agent.get_command(
 85                        root_dir.as_deref(),
 86                        extra_env,
 87                        delegate.status_tx,
 88                        delegate.new_version_available,
 89                        &mut cx.to_async(),
 90                    ))
 91                })??
 92                .await?;
 93            let connection = crate::acp::connect(
 94                name,
 95                command,
 96                root_dir.as_ref(),
 97                default_mode,
 98                is_remote,
 99                cx,
100            )
101            .await?;
102            Ok((connection, login))
103        })
104    }
105
106    fn into_any(self: Rc<Self>) -> Rc<dyn std::any::Any> {
107        self
108    }
109}