agent_settings.rs

   1mod agent_profile;
   2
   3use std::sync::Arc;
   4
   5use ::open_ai::Model as OpenAiModel;
   6use anthropic::Model as AnthropicModel;
   7use anyhow::{Result, bail};
   8use collections::IndexMap;
   9use deepseek::Model as DeepseekModel;
  10use gpui::{App, Pixels, SharedString};
  11use language_model::LanguageModel;
  12use lmstudio::Model as LmStudioModel;
  13use mistral::Model as MistralModel;
  14use ollama::Model as OllamaModel;
  15use schemars::{JsonSchema, schema::Schema};
  16use serde::{Deserialize, Serialize};
  17use settings::{Settings, SettingsSources};
  18
  19pub use crate::agent_profile::*;
  20
  21pub fn init(cx: &mut App) {
  22    AgentSettings::register(cx);
  23}
  24
  25#[derive(Copy, Clone, Default, Debug, Serialize, Deserialize, JsonSchema)]
  26#[serde(rename_all = "snake_case")]
  27pub enum AgentDockPosition {
  28    Left,
  29    #[default]
  30    Right,
  31    Bottom,
  32}
  33
  34#[derive(Copy, Clone, Default, Debug, Serialize, Deserialize, JsonSchema)]
  35#[serde(rename_all = "snake_case")]
  36pub enum DefaultView {
  37    #[default]
  38    Thread,
  39    TextThread,
  40}
  41
  42#[derive(Copy, Clone, Default, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
  43#[serde(rename_all = "snake_case")]
  44pub enum NotifyWhenAgentWaiting {
  45    #[default]
  46    PrimaryScreen,
  47    AllScreens,
  48    Never,
  49}
  50
  51#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq)]
  52#[serde(tag = "name", rename_all = "snake_case")]
  53#[schemars(deny_unknown_fields)]
  54pub enum AgentProviderContentV1 {
  55    #[serde(rename = "zed.dev")]
  56    ZedDotDev { default_model: Option<String> },
  57    #[serde(rename = "openai")]
  58    OpenAi {
  59        default_model: Option<OpenAiModel>,
  60        api_url: Option<String>,
  61        available_models: Option<Vec<OpenAiModel>>,
  62    },
  63    #[serde(rename = "anthropic")]
  64    Anthropic {
  65        default_model: Option<AnthropicModel>,
  66        api_url: Option<String>,
  67    },
  68    #[serde(rename = "ollama")]
  69    Ollama {
  70        default_model: Option<OllamaModel>,
  71        api_url: Option<String>,
  72    },
  73    #[serde(rename = "lmstudio")]
  74    LmStudio {
  75        default_model: Option<LmStudioModel>,
  76        api_url: Option<String>,
  77    },
  78    #[serde(rename = "deepseek")]
  79    DeepSeek {
  80        default_model: Option<DeepseekModel>,
  81        api_url: Option<String>,
  82    },
  83    #[serde(rename = "mistral")]
  84    Mistral {
  85        default_model: Option<MistralModel>,
  86        api_url: Option<String>,
  87    },
  88}
  89
  90#[derive(Default, Clone, Debug)]
  91pub struct AgentSettings {
  92    pub enabled: bool,
  93    pub button: bool,
  94    pub dock: AgentDockPosition,
  95    pub default_width: Pixels,
  96    pub default_height: Pixels,
  97    pub default_model: LanguageModelSelection,
  98    pub inline_assistant_model: Option<LanguageModelSelection>,
  99    pub commit_message_model: Option<LanguageModelSelection>,
 100    pub thread_summary_model: Option<LanguageModelSelection>,
 101    pub inline_alternatives: Vec<LanguageModelSelection>,
 102    pub using_outdated_settings_version: bool,
 103    pub default_profile: AgentProfileId,
 104    pub default_view: DefaultView,
 105    pub profiles: IndexMap<AgentProfileId, AgentProfile>,
 106    pub always_allow_tool_actions: bool,
 107    pub notify_when_agent_waiting: NotifyWhenAgentWaiting,
 108    pub play_sound_when_agent_done: bool,
 109    pub stream_edits: bool,
 110    pub single_file_review: bool,
 111    pub model_parameters: Vec<LanguageModelParameters>,
 112    pub preferred_completion_mode: CompletionMode,
 113    pub enable_feedback: bool,
 114}
 115
 116impl AgentSettings {
 117    pub fn temperature_for_model(model: &Arc<dyn LanguageModel>, cx: &App) -> Option<f32> {
 118        let settings = Self::get_global(cx);
 119        settings
 120            .model_parameters
 121            .iter()
 122            .rfind(|setting| setting.matches(model))
 123            .and_then(|m| m.temperature)
 124    }
 125
 126    pub fn set_inline_assistant_model(&mut self, provider: String, model: String) {
 127        self.inline_assistant_model = Some(LanguageModelSelection {
 128            provider: provider.into(),
 129            model,
 130        });
 131    }
 132
 133    pub fn set_commit_message_model(&mut self, provider: String, model: String) {
 134        self.commit_message_model = Some(LanguageModelSelection {
 135            provider: provider.into(),
 136            model,
 137        });
 138    }
 139
 140    pub fn set_thread_summary_model(&mut self, provider: String, model: String) {
 141        self.thread_summary_model = Some(LanguageModelSelection {
 142            provider: provider.into(),
 143            model,
 144        });
 145    }
 146}
 147
 148#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq)]
 149pub struct LanguageModelParameters {
 150    pub provider: Option<LanguageModelProviderSetting>,
 151    pub model: Option<SharedString>,
 152    pub temperature: Option<f32>,
 153}
 154
 155impl LanguageModelParameters {
 156    pub fn matches(&self, model: &Arc<dyn LanguageModel>) -> bool {
 157        if let Some(provider) = &self.provider {
 158            if provider.0 != model.provider_id().0 {
 159                return false;
 160            }
 161        }
 162        if let Some(setting_model) = &self.model {
 163            if *setting_model != model.id().0 {
 164                return false;
 165            }
 166        }
 167        true
 168    }
 169}
 170
 171/// Agent panel settings
 172#[derive(Clone, Serialize, Deserialize, Debug, Default)]
 173pub struct AgentSettingsContent {
 174    #[serde(flatten)]
 175    pub inner: Option<AgentSettingsContentInner>,
 176}
 177
 178#[derive(Clone, Serialize, Deserialize, Debug)]
 179#[serde(untagged)]
 180pub enum AgentSettingsContentInner {
 181    Versioned(Box<VersionedAgentSettingsContent>),
 182    Legacy(LegacyAgentSettingsContent),
 183}
 184
 185impl AgentSettingsContentInner {
 186    fn for_v2(content: AgentSettingsContentV2) -> Self {
 187        AgentSettingsContentInner::Versioned(Box::new(VersionedAgentSettingsContent::V2(content)))
 188    }
 189}
 190
 191impl JsonSchema for AgentSettingsContent {
 192    fn schema_name() -> String {
 193        VersionedAgentSettingsContent::schema_name()
 194    }
 195
 196    fn json_schema(r#gen: &mut schemars::r#gen::SchemaGenerator) -> Schema {
 197        VersionedAgentSettingsContent::json_schema(r#gen)
 198    }
 199
 200    fn is_referenceable() -> bool {
 201        VersionedAgentSettingsContent::is_referenceable()
 202    }
 203}
 204
 205impl AgentSettingsContent {
 206    pub fn is_version_outdated(&self) -> bool {
 207        match &self.inner {
 208            Some(AgentSettingsContentInner::Versioned(settings)) => match **settings {
 209                VersionedAgentSettingsContent::V1(_) => true,
 210                VersionedAgentSettingsContent::V2(_) => false,
 211            },
 212            Some(AgentSettingsContentInner::Legacy(_)) => true,
 213            None => false,
 214        }
 215    }
 216
 217    fn upgrade(&self) -> AgentSettingsContentV2 {
 218        match &self.inner {
 219            Some(AgentSettingsContentInner::Versioned(settings)) => match **settings {
 220                VersionedAgentSettingsContent::V1(ref settings) => AgentSettingsContentV2 {
 221                    enabled: settings.enabled,
 222                    button: settings.button,
 223                    dock: settings.dock,
 224                    default_width: settings.default_width,
 225                    default_height: settings.default_width,
 226                    default_model: settings
 227                        .provider
 228                        .clone()
 229                        .and_then(|provider| match provider {
 230                            AgentProviderContentV1::ZedDotDev { default_model } => default_model
 231                                .map(|model| LanguageModelSelection {
 232                                    provider: "zed.dev".into(),
 233                                    model,
 234                                }),
 235                            AgentProviderContentV1::OpenAi { default_model, .. } => default_model
 236                                .map(|model| LanguageModelSelection {
 237                                    provider: "openai".into(),
 238                                    model: model.id().to_string(),
 239                                }),
 240                            AgentProviderContentV1::Anthropic { default_model, .. } => {
 241                                default_model.map(|model| LanguageModelSelection {
 242                                    provider: "anthropic".into(),
 243                                    model: model.id().to_string(),
 244                                })
 245                            }
 246                            AgentProviderContentV1::Ollama { default_model, .. } => default_model
 247                                .map(|model| LanguageModelSelection {
 248                                    provider: "ollama".into(),
 249                                    model: model.id().to_string(),
 250                                }),
 251                            AgentProviderContentV1::LmStudio { default_model, .. } => default_model
 252                                .map(|model| LanguageModelSelection {
 253                                    provider: "lmstudio".into(),
 254                                    model: model.id().to_string(),
 255                                }),
 256                            AgentProviderContentV1::DeepSeek { default_model, .. } => default_model
 257                                .map(|model| LanguageModelSelection {
 258                                    provider: "deepseek".into(),
 259                                    model: model.id().to_string(),
 260                                }),
 261                            AgentProviderContentV1::Mistral { default_model, .. } => default_model
 262                                .map(|model| LanguageModelSelection {
 263                                    provider: "mistral".into(),
 264                                    model: model.id().to_string(),
 265                                }),
 266                        }),
 267                    inline_assistant_model: None,
 268                    commit_message_model: None,
 269                    thread_summary_model: None,
 270                    inline_alternatives: None,
 271                    default_profile: None,
 272                    default_view: None,
 273                    profiles: None,
 274                    always_allow_tool_actions: None,
 275                    notify_when_agent_waiting: None,
 276                    stream_edits: None,
 277                    single_file_review: None,
 278                    model_parameters: Vec::new(),
 279                    preferred_completion_mode: None,
 280                    enable_feedback: None,
 281                    play_sound_when_agent_done: None,
 282                },
 283                VersionedAgentSettingsContent::V2(ref settings) => settings.clone(),
 284            },
 285            Some(AgentSettingsContentInner::Legacy(settings)) => AgentSettingsContentV2 {
 286                enabled: None,
 287                button: settings.button,
 288                dock: settings.dock,
 289                default_width: settings.default_width,
 290                default_height: settings.default_height,
 291                default_model: Some(LanguageModelSelection {
 292                    provider: "openai".into(),
 293                    model: settings
 294                        .default_open_ai_model
 295                        .clone()
 296                        .unwrap_or_default()
 297                        .id()
 298                        .to_string(),
 299                }),
 300                inline_assistant_model: None,
 301                commit_message_model: None,
 302                thread_summary_model: None,
 303                inline_alternatives: None,
 304                default_profile: None,
 305                default_view: None,
 306                profiles: None,
 307                always_allow_tool_actions: None,
 308                notify_when_agent_waiting: None,
 309                stream_edits: None,
 310                single_file_review: None,
 311                model_parameters: Vec::new(),
 312                preferred_completion_mode: None,
 313                enable_feedback: None,
 314                play_sound_when_agent_done: None,
 315            },
 316            None => AgentSettingsContentV2::default(),
 317        }
 318    }
 319
 320    pub fn set_dock(&mut self, dock: AgentDockPosition) {
 321        match &mut self.inner {
 322            Some(AgentSettingsContentInner::Versioned(settings)) => match **settings {
 323                VersionedAgentSettingsContent::V1(ref mut settings) => {
 324                    settings.dock = Some(dock);
 325                }
 326                VersionedAgentSettingsContent::V2(ref mut settings) => {
 327                    settings.dock = Some(dock);
 328                }
 329            },
 330            Some(AgentSettingsContentInner::Legacy(settings)) => {
 331                settings.dock = Some(dock);
 332            }
 333            None => {
 334                self.inner = Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 335                    dock: Some(dock),
 336                    ..Default::default()
 337                }))
 338            }
 339        }
 340    }
 341
 342    pub fn set_model(&mut self, language_model: Arc<dyn LanguageModel>) {
 343        let model = language_model.id().0.to_string();
 344        let provider = language_model.provider_id().0.to_string();
 345
 346        match &mut self.inner {
 347            Some(AgentSettingsContentInner::Versioned(settings)) => match **settings {
 348                VersionedAgentSettingsContent::V1(ref mut settings) => match provider.as_ref() {
 349                    "zed.dev" => {
 350                        log::warn!("attempted to set zed.dev model on outdated settings");
 351                    }
 352                    "anthropic" => {
 353                        let api_url = match &settings.provider {
 354                            Some(AgentProviderContentV1::Anthropic { api_url, .. }) => {
 355                                api_url.clone()
 356                            }
 357                            _ => None,
 358                        };
 359                        settings.provider = Some(AgentProviderContentV1::Anthropic {
 360                            default_model: AnthropicModel::from_id(&model).ok(),
 361                            api_url,
 362                        });
 363                    }
 364                    "ollama" => {
 365                        let api_url = match &settings.provider {
 366                            Some(AgentProviderContentV1::Ollama { api_url, .. }) => api_url.clone(),
 367                            _ => None,
 368                        };
 369                        settings.provider = Some(AgentProviderContentV1::Ollama {
 370                            default_model: Some(ollama::Model::new(
 371                                &model,
 372                                None,
 373                                None,
 374                                Some(language_model.supports_tools()),
 375                                Some(language_model.supports_images()),
 376                                None,
 377                            )),
 378                            api_url,
 379                        });
 380                    }
 381                    "lmstudio" => {
 382                        let api_url = match &settings.provider {
 383                            Some(AgentProviderContentV1::LmStudio { api_url, .. }) => {
 384                                api_url.clone()
 385                            }
 386                            _ => None,
 387                        };
 388                        settings.provider = Some(AgentProviderContentV1::LmStudio {
 389                            default_model: Some(lmstudio::Model::new(&model, None, None, false)),
 390                            api_url,
 391                        });
 392                    }
 393                    "openai" => {
 394                        let (api_url, available_models) = match &settings.provider {
 395                            Some(AgentProviderContentV1::OpenAi {
 396                                api_url,
 397                                available_models,
 398                                ..
 399                            }) => (api_url.clone(), available_models.clone()),
 400                            _ => (None, None),
 401                        };
 402                        settings.provider = Some(AgentProviderContentV1::OpenAi {
 403                            default_model: OpenAiModel::from_id(&model).ok(),
 404                            api_url,
 405                            available_models,
 406                        });
 407                    }
 408                    "deepseek" => {
 409                        let api_url = match &settings.provider {
 410                            Some(AgentProviderContentV1::DeepSeek { api_url, .. }) => {
 411                                api_url.clone()
 412                            }
 413                            _ => None,
 414                        };
 415                        settings.provider = Some(AgentProviderContentV1::DeepSeek {
 416                            default_model: DeepseekModel::from_id(&model).ok(),
 417                            api_url,
 418                        });
 419                    }
 420                    _ => {}
 421                },
 422                VersionedAgentSettingsContent::V2(ref mut settings) => {
 423                    settings.default_model = Some(LanguageModelSelection {
 424                        provider: provider.into(),
 425                        model,
 426                    });
 427                }
 428            },
 429            Some(AgentSettingsContentInner::Legacy(settings)) => {
 430                if let Ok(model) = OpenAiModel::from_id(&language_model.id().0) {
 431                    settings.default_open_ai_model = Some(model);
 432                }
 433            }
 434            None => {
 435                self.inner = Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 436                    default_model: Some(LanguageModelSelection {
 437                        provider: provider.into(),
 438                        model,
 439                    }),
 440                    ..Default::default()
 441                }));
 442            }
 443        }
 444    }
 445
 446    pub fn set_inline_assistant_model(&mut self, provider: String, model: String) {
 447        self.v2_setting(|setting| {
 448            setting.inline_assistant_model = Some(LanguageModelSelection {
 449                provider: provider.into(),
 450                model,
 451            });
 452            Ok(())
 453        })
 454        .ok();
 455    }
 456
 457    pub fn set_commit_message_model(&mut self, provider: String, model: String) {
 458        self.v2_setting(|setting| {
 459            setting.commit_message_model = Some(LanguageModelSelection {
 460                provider: provider.into(),
 461                model,
 462            });
 463            Ok(())
 464        })
 465        .ok();
 466    }
 467
 468    pub fn v2_setting(
 469        &mut self,
 470        f: impl FnOnce(&mut AgentSettingsContentV2) -> anyhow::Result<()>,
 471    ) -> anyhow::Result<()> {
 472        match self.inner.get_or_insert_with(|| {
 473            AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 474                ..Default::default()
 475            })
 476        }) {
 477            AgentSettingsContentInner::Versioned(boxed) => {
 478                if let VersionedAgentSettingsContent::V2(ref mut settings) = **boxed {
 479                    f(settings)
 480                } else {
 481                    Ok(())
 482                }
 483            }
 484            _ => Ok(()),
 485        }
 486    }
 487
 488    pub fn set_thread_summary_model(&mut self, provider: String, model: String) {
 489        self.v2_setting(|setting| {
 490            setting.thread_summary_model = Some(LanguageModelSelection {
 491                provider: provider.into(),
 492                model,
 493            });
 494            Ok(())
 495        })
 496        .ok();
 497    }
 498
 499    pub fn set_always_allow_tool_actions(&mut self, allow: bool) {
 500        self.v2_setting(|setting| {
 501            setting.always_allow_tool_actions = Some(allow);
 502            Ok(())
 503        })
 504        .ok();
 505    }
 506
 507    pub fn set_play_sound_when_agent_done(&mut self, allow: bool) {
 508        self.v2_setting(|setting| {
 509            setting.play_sound_when_agent_done = Some(allow);
 510            Ok(())
 511        })
 512        .ok();
 513    }
 514
 515    pub fn set_single_file_review(&mut self, allow: bool) {
 516        self.v2_setting(|setting| {
 517            setting.single_file_review = Some(allow);
 518            Ok(())
 519        })
 520        .ok();
 521    }
 522
 523    pub fn set_profile(&mut self, profile_id: AgentProfileId) {
 524        self.v2_setting(|setting| {
 525            setting.default_profile = Some(profile_id);
 526            Ok(())
 527        })
 528        .ok();
 529    }
 530
 531    pub fn create_profile(
 532        &mut self,
 533        profile_id: AgentProfileId,
 534        profile: AgentProfile,
 535    ) -> Result<()> {
 536        self.v2_setting(|settings| {
 537            let profiles = settings.profiles.get_or_insert_default();
 538            if profiles.contains_key(&profile_id) {
 539                bail!("profile with ID '{profile_id}' already exists");
 540            }
 541
 542            profiles.insert(
 543                profile_id,
 544                AgentProfileContent {
 545                    name: profile.name.into(),
 546                    tools: profile.tools,
 547                    enable_all_context_servers: Some(profile.enable_all_context_servers),
 548                    context_servers: profile
 549                        .context_servers
 550                        .into_iter()
 551                        .map(|(server_id, preset)| {
 552                            (
 553                                server_id,
 554                                ContextServerPresetContent {
 555                                    tools: preset.tools,
 556                                },
 557                            )
 558                        })
 559                        .collect(),
 560                },
 561            );
 562
 563            Ok(())
 564        })
 565    }
 566}
 567
 568#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug)]
 569#[serde(tag = "version")]
 570#[schemars(deny_unknown_fields)]
 571pub enum VersionedAgentSettingsContent {
 572    #[serde(rename = "1")]
 573    V1(AgentSettingsContentV1),
 574    #[serde(rename = "2")]
 575    V2(AgentSettingsContentV2),
 576}
 577
 578impl Default for VersionedAgentSettingsContent {
 579    fn default() -> Self {
 580        Self::V2(AgentSettingsContentV2 {
 581            enabled: None,
 582            button: None,
 583            dock: None,
 584            default_width: None,
 585            default_height: None,
 586            default_model: None,
 587            inline_assistant_model: None,
 588            commit_message_model: None,
 589            thread_summary_model: None,
 590            inline_alternatives: None,
 591            default_profile: None,
 592            default_view: None,
 593            profiles: None,
 594            always_allow_tool_actions: None,
 595            notify_when_agent_waiting: None,
 596            stream_edits: None,
 597            single_file_review: None,
 598            model_parameters: Vec::new(),
 599            preferred_completion_mode: None,
 600            enable_feedback: None,
 601            play_sound_when_agent_done: None,
 602        })
 603    }
 604}
 605
 606#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug, Default)]
 607#[schemars(deny_unknown_fields)]
 608pub struct AgentSettingsContentV2 {
 609    /// Whether the Agent is enabled.
 610    ///
 611    /// Default: true
 612    enabled: Option<bool>,
 613    /// Whether to show the agent panel button in the status bar.
 614    ///
 615    /// Default: true
 616    button: Option<bool>,
 617    /// Where to dock the agent panel.
 618    ///
 619    /// Default: right
 620    dock: Option<AgentDockPosition>,
 621    /// Default width in pixels when the agent panel is docked to the left or right.
 622    ///
 623    /// Default: 640
 624    default_width: Option<f32>,
 625    /// Default height in pixels when the agent panel is docked to the bottom.
 626    ///
 627    /// Default: 320
 628    default_height: Option<f32>,
 629    /// The default model to use when creating new chats and for other features when a specific model is not specified.
 630    default_model: Option<LanguageModelSelection>,
 631    /// Model to use for the inline assistant. Defaults to default_model when not specified.
 632    inline_assistant_model: Option<LanguageModelSelection>,
 633    /// Model to use for generating git commit messages. Defaults to default_model when not specified.
 634    commit_message_model: Option<LanguageModelSelection>,
 635    /// Model to use for generating thread summaries. Defaults to default_model when not specified.
 636    thread_summary_model: Option<LanguageModelSelection>,
 637    /// Additional models with which to generate alternatives when performing inline assists.
 638    inline_alternatives: Option<Vec<LanguageModelSelection>>,
 639    /// The default profile to use in the Agent.
 640    ///
 641    /// Default: write
 642    default_profile: Option<AgentProfileId>,
 643    /// Which view type to show by default in the agent panel.
 644    ///
 645    /// Default: "thread"
 646    default_view: Option<DefaultView>,
 647    /// The available agent profiles.
 648    pub profiles: Option<IndexMap<AgentProfileId, AgentProfileContent>>,
 649    /// Whenever a tool action would normally wait for your confirmation
 650    /// that you allow it, always choose to allow it.
 651    ///
 652    /// Default: false
 653    always_allow_tool_actions: Option<bool>,
 654    /// Where to show a popup notification when the agent is waiting for user input.
 655    ///
 656    /// Default: "primary_screen"
 657    notify_when_agent_waiting: Option<NotifyWhenAgentWaiting>,
 658    /// Whether to play a sound when the agent has either completed its response, or needs user input.
 659    ///
 660    /// Default: false
 661    play_sound_when_agent_done: Option<bool>,
 662    /// Whether to stream edits from the agent as they are received.
 663    ///
 664    /// Default: false
 665    stream_edits: Option<bool>,
 666    /// Whether to display agent edits in single-file editors in addition to the review multibuffer pane.
 667    ///
 668    /// Default: true
 669    single_file_review: Option<bool>,
 670    /// Additional parameters for language model requests. When making a request
 671    /// to a model, parameters will be taken from the last entry in this list
 672    /// that matches the model's provider and name. In each entry, both provider
 673    /// and model are optional, so that you can specify parameters for either
 674    /// one.
 675    ///
 676    /// Default: []
 677    #[serde(default)]
 678    model_parameters: Vec<LanguageModelParameters>,
 679    /// What completion mode to enable for new threads
 680    ///
 681    /// Default: normal
 682    preferred_completion_mode: Option<CompletionMode>,
 683    /// Whether to show thumb buttons for feedback in the agent panel.
 684    ///
 685    /// Default: true
 686    enable_feedback: Option<bool>,
 687}
 688
 689#[derive(Clone, Copy, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Default)]
 690#[serde(rename_all = "snake_case")]
 691pub enum CompletionMode {
 692    #[default]
 693    Normal,
 694    #[serde(alias = "max")]
 695    Burn,
 696}
 697
 698impl From<CompletionMode> for zed_llm_client::CompletionMode {
 699    fn from(value: CompletionMode) -> Self {
 700        match value {
 701            CompletionMode::Normal => zed_llm_client::CompletionMode::Normal,
 702            CompletionMode::Burn => zed_llm_client::CompletionMode::Max,
 703        }
 704    }
 705}
 706
 707#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq)]
 708pub struct LanguageModelSelection {
 709    pub provider: LanguageModelProviderSetting,
 710    pub model: String,
 711}
 712
 713#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 714pub struct LanguageModelProviderSetting(pub String);
 715
 716impl JsonSchema for LanguageModelProviderSetting {
 717    fn schema_name() -> String {
 718        "LanguageModelProviderSetting".into()
 719    }
 720
 721    fn json_schema(_: &mut schemars::r#gen::SchemaGenerator) -> Schema {
 722        schemars::schema::SchemaObject {
 723            enum_values: Some(vec![
 724                "anthropic".into(),
 725                "amazon-bedrock".into(),
 726                "google".into(),
 727                "lmstudio".into(),
 728                "ollama".into(),
 729                "openai".into(),
 730                "zed.dev".into(),
 731                "copilot_chat".into(),
 732                "deepseek".into(),
 733                "mistral".into(),
 734            ]),
 735            ..Default::default()
 736        }
 737        .into()
 738    }
 739}
 740
 741impl From<String> for LanguageModelProviderSetting {
 742    fn from(provider: String) -> Self {
 743        Self(provider)
 744    }
 745}
 746
 747impl From<&str> for LanguageModelProviderSetting {
 748    fn from(provider: &str) -> Self {
 749        Self(provider.to_string())
 750    }
 751}
 752
 753impl Default for LanguageModelSelection {
 754    fn default() -> Self {
 755        Self {
 756            provider: LanguageModelProviderSetting("openai".to_string()),
 757            model: "gpt-4".to_string(),
 758        }
 759    }
 760}
 761
 762#[derive(Debug, PartialEq, Clone, Serialize, Deserialize, JsonSchema)]
 763pub struct AgentProfileContent {
 764    pub name: Arc<str>,
 765    #[serde(default)]
 766    pub tools: IndexMap<Arc<str>, bool>,
 767    /// Whether all context servers are enabled by default.
 768    pub enable_all_context_servers: Option<bool>,
 769    #[serde(default)]
 770    pub context_servers: IndexMap<Arc<str>, ContextServerPresetContent>,
 771}
 772
 773#[derive(Debug, PartialEq, Clone, Default, Serialize, Deserialize, JsonSchema)]
 774pub struct ContextServerPresetContent {
 775    pub tools: IndexMap<Arc<str>, bool>,
 776}
 777
 778#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug)]
 779#[schemars(deny_unknown_fields)]
 780pub struct AgentSettingsContentV1 {
 781    /// Whether the Agent is enabled.
 782    ///
 783    /// Default: true
 784    enabled: Option<bool>,
 785    /// Whether to show the Agent panel button in the status bar.
 786    ///
 787    /// Default: true
 788    button: Option<bool>,
 789    /// Where to dock the Agent.
 790    ///
 791    /// Default: right
 792    dock: Option<AgentDockPosition>,
 793    /// Default width in pixels when the Agent is docked to the left or right.
 794    ///
 795    /// Default: 640
 796    default_width: Option<f32>,
 797    /// Default height in pixels when the Agent is docked to the bottom.
 798    ///
 799    /// Default: 320
 800    default_height: Option<f32>,
 801    /// The provider of the Agent service.
 802    ///
 803    /// This can be "openai", "anthropic", "ollama", "lmstudio", "deepseek", "zed.dev"
 804    /// each with their respective default models and configurations.
 805    provider: Option<AgentProviderContentV1>,
 806}
 807
 808#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug)]
 809#[schemars(deny_unknown_fields)]
 810pub struct LegacyAgentSettingsContent {
 811    /// Whether to show the Agent panel button in the status bar.
 812    ///
 813    /// Default: true
 814    pub button: Option<bool>,
 815    /// Where to dock the Agent.
 816    ///
 817    /// Default: right
 818    pub dock: Option<AgentDockPosition>,
 819    /// Default width in pixels when the Agent is docked to the left or right.
 820    ///
 821    /// Default: 640
 822    pub default_width: Option<f32>,
 823    /// Default height in pixels when the Agent is docked to the bottom.
 824    ///
 825    /// Default: 320
 826    pub default_height: Option<f32>,
 827    /// The default OpenAI model to use when creating new chats.
 828    ///
 829    /// Default: gpt-4-1106-preview
 830    pub default_open_ai_model: Option<OpenAiModel>,
 831    /// OpenAI API base URL to use when creating new chats.
 832    ///
 833    /// Default: <https://api.openai.com/v1>
 834    pub openai_api_url: Option<String>,
 835}
 836
 837impl Settings for AgentSettings {
 838    const KEY: Option<&'static str> = Some("agent");
 839
 840    const FALLBACK_KEY: Option<&'static str> = Some("assistant");
 841
 842    const PRESERVED_KEYS: Option<&'static [&'static str]> = Some(&["version"]);
 843
 844    type FileContent = AgentSettingsContent;
 845
 846    fn load(
 847        sources: SettingsSources<Self::FileContent>,
 848        _: &mut gpui::App,
 849    ) -> anyhow::Result<Self> {
 850        let mut settings = AgentSettings::default();
 851
 852        for value in sources.defaults_and_customizations() {
 853            if value.is_version_outdated() {
 854                settings.using_outdated_settings_version = true;
 855            }
 856
 857            let value = value.upgrade();
 858            merge(&mut settings.enabled, value.enabled);
 859            merge(&mut settings.button, value.button);
 860            merge(&mut settings.dock, value.dock);
 861            merge(
 862                &mut settings.default_width,
 863                value.default_width.map(Into::into),
 864            );
 865            merge(
 866                &mut settings.default_height,
 867                value.default_height.map(Into::into),
 868            );
 869            merge(&mut settings.default_model, value.default_model);
 870            settings.inline_assistant_model = value
 871                .inline_assistant_model
 872                .or(settings.inline_assistant_model.take());
 873            settings.commit_message_model = value
 874                .commit_message_model
 875                .or(settings.commit_message_model.take());
 876            settings.thread_summary_model = value
 877                .thread_summary_model
 878                .or(settings.thread_summary_model.take());
 879            merge(&mut settings.inline_alternatives, value.inline_alternatives);
 880            merge(
 881                &mut settings.always_allow_tool_actions,
 882                value.always_allow_tool_actions,
 883            );
 884            merge(
 885                &mut settings.notify_when_agent_waiting,
 886                value.notify_when_agent_waiting,
 887            );
 888            merge(
 889                &mut settings.play_sound_when_agent_done,
 890                value.play_sound_when_agent_done,
 891            );
 892            merge(&mut settings.stream_edits, value.stream_edits);
 893            merge(&mut settings.single_file_review, value.single_file_review);
 894            merge(&mut settings.default_profile, value.default_profile);
 895            merge(&mut settings.default_view, value.default_view);
 896            merge(
 897                &mut settings.preferred_completion_mode,
 898                value.preferred_completion_mode,
 899            );
 900            merge(&mut settings.enable_feedback, value.enable_feedback);
 901
 902            settings
 903                .model_parameters
 904                .extend_from_slice(&value.model_parameters);
 905
 906            if let Some(profiles) = value.profiles {
 907                settings
 908                    .profiles
 909                    .extend(profiles.into_iter().map(|(id, profile)| {
 910                        (
 911                            id,
 912                            AgentProfile {
 913                                name: profile.name.into(),
 914                                tools: profile.tools,
 915                                enable_all_context_servers: profile
 916                                    .enable_all_context_servers
 917                                    .unwrap_or_default(),
 918                                context_servers: profile
 919                                    .context_servers
 920                                    .into_iter()
 921                                    .map(|(context_server_id, preset)| {
 922                                        (
 923                                            context_server_id,
 924                                            ContextServerPreset {
 925                                                tools: preset.tools.clone(),
 926                                            },
 927                                        )
 928                                    })
 929                                    .collect(),
 930                            },
 931                        )
 932                    }));
 933            }
 934        }
 935
 936        Ok(settings)
 937    }
 938
 939    fn import_from_vscode(vscode: &settings::VsCodeSettings, current: &mut Self::FileContent) {
 940        if let Some(b) = vscode
 941            .read_value("chat.agent.enabled")
 942            .and_then(|b| b.as_bool())
 943        {
 944            match &mut current.inner {
 945                Some(AgentSettingsContentInner::Versioned(versioned)) => match versioned.as_mut() {
 946                    VersionedAgentSettingsContent::V1(setting) => {
 947                        setting.enabled = Some(b);
 948                        setting.button = Some(b);
 949                    }
 950
 951                    VersionedAgentSettingsContent::V2(setting) => {
 952                        setting.enabled = Some(b);
 953                        setting.button = Some(b);
 954                    }
 955                },
 956                Some(AgentSettingsContentInner::Legacy(setting)) => setting.button = Some(b),
 957                None => {
 958                    current.inner =
 959                        Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 960                            enabled: Some(b),
 961                            button: Some(b),
 962                            ..Default::default()
 963                        }));
 964                }
 965            }
 966        }
 967    }
 968}
 969
 970fn merge<T>(target: &mut T, value: Option<T>) {
 971    if let Some(value) = value {
 972        *target = value;
 973    }
 974}
 975
 976#[cfg(test)]
 977mod tests {
 978    use fs::Fs;
 979    use gpui::{ReadGlobal, TestAppContext};
 980    use settings::SettingsStore;
 981
 982    use super::*;
 983
 984    #[gpui::test]
 985    async fn test_deserialize_agent_settings_with_version(cx: &mut TestAppContext) {
 986        let fs = fs::FakeFs::new(cx.executor().clone());
 987        fs.create_dir(paths::settings_file().parent().unwrap())
 988            .await
 989            .unwrap();
 990
 991        cx.update(|cx| {
 992            let test_settings = settings::SettingsStore::test(cx);
 993            cx.set_global(test_settings);
 994            AgentSettings::register(cx);
 995        });
 996
 997        cx.update(|cx| {
 998            assert!(!AgentSettings::get_global(cx).using_outdated_settings_version);
 999            assert_eq!(
1000                AgentSettings::get_global(cx).default_model,
1001                LanguageModelSelection {
1002                    provider: "zed.dev".into(),
1003                    model: "claude-sonnet-4".into(),
1004                }
1005            );
1006        });
1007
1008        cx.update(|cx| {
1009            settings::SettingsStore::global(cx).update_settings_file::<AgentSettings>(
1010                fs.clone(),
1011                |settings, _| {
1012                    *settings = AgentSettingsContent {
1013                        inner: Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
1014                            default_model: Some(LanguageModelSelection {
1015                                provider: "test-provider".into(),
1016                                model: "gpt-99".into(),
1017                            }),
1018                            inline_assistant_model: None,
1019                            commit_message_model: None,
1020                            thread_summary_model: None,
1021                            inline_alternatives: None,
1022                            enabled: None,
1023                            button: None,
1024                            dock: None,
1025                            default_width: None,
1026                            default_height: None,
1027                            default_profile: None,
1028                            default_view: None,
1029                            profiles: None,
1030                            always_allow_tool_actions: None,
1031                            play_sound_when_agent_done: None,
1032                            notify_when_agent_waiting: None,
1033                            stream_edits: None,
1034                            single_file_review: None,
1035                            enable_feedback: None,
1036                            model_parameters: Vec::new(),
1037                            preferred_completion_mode: None,
1038                        })),
1039                    }
1040                },
1041            );
1042        });
1043
1044        cx.run_until_parked();
1045
1046        let raw_settings_value = fs.load(paths::settings_file()).await.unwrap();
1047        assert!(raw_settings_value.contains(r#""version": "2""#));
1048
1049        #[derive(Debug, Deserialize)]
1050        struct AgentSettingsTest {
1051            agent: AgentSettingsContent,
1052        }
1053
1054        let agent_settings: AgentSettingsTest =
1055            serde_json_lenient::from_str(&raw_settings_value).unwrap();
1056
1057        assert!(!agent_settings.agent.is_version_outdated());
1058    }
1059
1060    #[gpui::test]
1061    async fn test_load_settings_from_old_key(cx: &mut TestAppContext) {
1062        let fs = fs::FakeFs::new(cx.executor().clone());
1063        fs.create_dir(paths::settings_file().parent().unwrap())
1064            .await
1065            .unwrap();
1066
1067        cx.update(|cx| {
1068            let mut test_settings = settings::SettingsStore::test(cx);
1069            let user_settings_content = r#"{
1070            "assistant": {
1071                "enabled": true,
1072                "version": "2",
1073                "default_model": {
1074                  "provider": "zed.dev",
1075                  "model": "gpt-99"
1076                },
1077            }}"#;
1078            test_settings
1079                .set_user_settings(user_settings_content, cx)
1080                .unwrap();
1081            cx.set_global(test_settings);
1082            AgentSettings::register(cx);
1083        });
1084
1085        cx.run_until_parked();
1086
1087        let agent_settings = cx.update(|cx| AgentSettings::get_global(cx).clone());
1088        assert!(agent_settings.enabled);
1089        assert!(!agent_settings.using_outdated_settings_version);
1090        assert_eq!(agent_settings.default_model.model, "gpt-99");
1091
1092        cx.update_global::<SettingsStore, _>(|settings_store, cx| {
1093            settings_store.update_user_settings::<AgentSettings>(cx, |settings| {
1094                *settings = AgentSettingsContent {
1095                    inner: Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
1096                        enabled: Some(false),
1097                        default_model: Some(LanguageModelSelection {
1098                            provider: "xai".to_owned().into(),
1099                            model: "grok".to_owned(),
1100                        }),
1101                        ..Default::default()
1102                    })),
1103                };
1104            });
1105        });
1106
1107        cx.run_until_parked();
1108
1109        let settings = cx.update(|cx| SettingsStore::global(cx).raw_user_settings().clone());
1110
1111        #[derive(Debug, Deserialize)]
1112        struct AgentSettingsTest {
1113            assistant: AgentSettingsContent,
1114            agent: Option<serde_json_lenient::Value>,
1115        }
1116
1117        let agent_settings: AgentSettingsTest = serde_json::from_value(settings).unwrap();
1118        assert!(agent_settings.agent.is_none());
1119    }
1120}