custom.rs

  1use crate::AgentServerDelegate;
  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::<AllAgentServersSettings>(fs, cx, move |settings, _| {
 53            settings.custom.get_mut(&name).unwrap().default_mode = mode_id.map(|m| m.to_string())
 54        });
 55    }
 56
 57    fn connect(
 58        &self,
 59        root_dir: Option<&Path>,
 60        delegate: AgentServerDelegate,
 61        cx: &mut App,
 62    ) -> Task<Result<(Rc<dyn AgentConnection>, Option<task::SpawnInTerminal>)>> {
 63        let name = self.name();
 64        let root_dir = root_dir.map(|root_dir| root_dir.to_string_lossy().to_string());
 65        let is_remote = delegate.project.read(cx).is_via_remote_server();
 66        let default_mode = self.default_mode(cx);
 67        let store = delegate.store.downgrade();
 68
 69        cx.spawn(async move |cx| {
 70            let (command, root_dir, login) = store
 71                .update(cx, |store, cx| {
 72                    let agent = store
 73                        .get_external_agent(&ExternalAgentServerName(name.clone()))
 74                        .with_context(|| {
 75                            format!("Custom agent server `{}` is not registered", name)
 76                        })?;
 77                    anyhow::Ok(agent.get_command(
 78                        root_dir.as_deref(),
 79                        Default::default(),
 80                        delegate.status_tx,
 81                        delegate.new_version_available,
 82                        &mut cx.to_async(),
 83                    ))
 84                })??
 85                .await?;
 86            let connection = crate::acp::connect(
 87                name,
 88                command,
 89                root_dir.as_ref(),
 90                default_mode,
 91                is_remote,
 92                cx,
 93            )
 94            .await?;
 95            Ok((connection, login))
 96        })
 97    }
 98
 99    fn into_any(self: Rc<Self>) -> Rc<dyn std::any::Any> {
100        self
101    }
102}