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                                None,
 376                            )),
 377                            api_url,
 378                        });
 379                    }
 380                    "lmstudio" => {
 381                        let api_url = match &settings.provider {
 382                            Some(AgentProviderContentV1::LmStudio { api_url, .. }) => {
 383                                api_url.clone()
 384                            }
 385                            _ => None,
 386                        };
 387                        settings.provider = Some(AgentProviderContentV1::LmStudio {
 388                            default_model: Some(lmstudio::Model::new(&model, None, None, false)),
 389                            api_url,
 390                        });
 391                    }
 392                    "openai" => {
 393                        let (api_url, available_models) = match &settings.provider {
 394                            Some(AgentProviderContentV1::OpenAi {
 395                                api_url,
 396                                available_models,
 397                                ..
 398                            }) => (api_url.clone(), available_models.clone()),
 399                            _ => (None, None),
 400                        };
 401                        settings.provider = Some(AgentProviderContentV1::OpenAi {
 402                            default_model: OpenAiModel::from_id(&model).ok(),
 403                            api_url,
 404                            available_models,
 405                        });
 406                    }
 407                    "deepseek" => {
 408                        let api_url = match &settings.provider {
 409                            Some(AgentProviderContentV1::DeepSeek { api_url, .. }) => {
 410                                api_url.clone()
 411                            }
 412                            _ => None,
 413                        };
 414                        settings.provider = Some(AgentProviderContentV1::DeepSeek {
 415                            default_model: DeepseekModel::from_id(&model).ok(),
 416                            api_url,
 417                        });
 418                    }
 419                    _ => {}
 420                },
 421                VersionedAgentSettingsContent::V2(ref mut settings) => {
 422                    settings.default_model = Some(LanguageModelSelection {
 423                        provider: provider.into(),
 424                        model,
 425                    });
 426                }
 427            },
 428            Some(AgentSettingsContentInner::Legacy(settings)) => {
 429                if let Ok(model) = OpenAiModel::from_id(&language_model.id().0) {
 430                    settings.default_open_ai_model = Some(model);
 431                }
 432            }
 433            None => {
 434                self.inner = Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 435                    default_model: Some(LanguageModelSelection {
 436                        provider: provider.into(),
 437                        model,
 438                    }),
 439                    ..Default::default()
 440                }));
 441            }
 442        }
 443    }
 444
 445    pub fn set_inline_assistant_model(&mut self, provider: String, model: String) {
 446        self.v2_setting(|setting| {
 447            setting.inline_assistant_model = Some(LanguageModelSelection {
 448                provider: provider.into(),
 449                model,
 450            });
 451            Ok(())
 452        })
 453        .ok();
 454    }
 455
 456    pub fn set_commit_message_model(&mut self, provider: String, model: String) {
 457        self.v2_setting(|setting| {
 458            setting.commit_message_model = Some(LanguageModelSelection {
 459                provider: provider.into(),
 460                model,
 461            });
 462            Ok(())
 463        })
 464        .ok();
 465    }
 466
 467    pub fn v2_setting(
 468        &mut self,
 469        f: impl FnOnce(&mut AgentSettingsContentV2) -> anyhow::Result<()>,
 470    ) -> anyhow::Result<()> {
 471        match self.inner.get_or_insert_with(|| {
 472            AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 473                ..Default::default()
 474            })
 475        }) {
 476            AgentSettingsContentInner::Versioned(boxed) => {
 477                if let VersionedAgentSettingsContent::V2(ref mut settings) = **boxed {
 478                    f(settings)
 479                } else {
 480                    Ok(())
 481                }
 482            }
 483            _ => Ok(()),
 484        }
 485    }
 486
 487    pub fn set_thread_summary_model(&mut self, provider: String, model: String) {
 488        self.v2_setting(|setting| {
 489            setting.thread_summary_model = Some(LanguageModelSelection {
 490                provider: provider.into(),
 491                model,
 492            });
 493            Ok(())
 494        })
 495        .ok();
 496    }
 497
 498    pub fn set_always_allow_tool_actions(&mut self, allow: bool) {
 499        self.v2_setting(|setting| {
 500            setting.always_allow_tool_actions = Some(allow);
 501            Ok(())
 502        })
 503        .ok();
 504    }
 505
 506    pub fn set_play_sound_when_agent_done(&mut self, allow: bool) {
 507        self.v2_setting(|setting| {
 508            setting.play_sound_when_agent_done = Some(allow);
 509            Ok(())
 510        })
 511        .ok();
 512    }
 513
 514    pub fn set_single_file_review(&mut self, allow: bool) {
 515        self.v2_setting(|setting| {
 516            setting.single_file_review = Some(allow);
 517            Ok(())
 518        })
 519        .ok();
 520    }
 521
 522    pub fn set_profile(&mut self, profile_id: AgentProfileId) {
 523        self.v2_setting(|setting| {
 524            setting.default_profile = Some(profile_id);
 525            Ok(())
 526        })
 527        .ok();
 528    }
 529
 530    pub fn create_profile(
 531        &mut self,
 532        profile_id: AgentProfileId,
 533        profile: AgentProfile,
 534    ) -> Result<()> {
 535        self.v2_setting(|settings| {
 536            let profiles = settings.profiles.get_or_insert_default();
 537            if profiles.contains_key(&profile_id) {
 538                bail!("profile with ID '{profile_id}' already exists");
 539            }
 540
 541            profiles.insert(
 542                profile_id,
 543                AgentProfileContent {
 544                    name: profile.name.into(),
 545                    tools: profile.tools,
 546                    enable_all_context_servers: Some(profile.enable_all_context_servers),
 547                    context_servers: profile
 548                        .context_servers
 549                        .into_iter()
 550                        .map(|(server_id, preset)| {
 551                            (
 552                                server_id,
 553                                ContextServerPresetContent {
 554                                    tools: preset.tools,
 555                                },
 556                            )
 557                        })
 558                        .collect(),
 559                },
 560            );
 561
 562            Ok(())
 563        })
 564    }
 565}
 566
 567#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug)]
 568#[serde(tag = "version")]
 569#[schemars(deny_unknown_fields)]
 570pub enum VersionedAgentSettingsContent {
 571    #[serde(rename = "1")]
 572    V1(AgentSettingsContentV1),
 573    #[serde(rename = "2")]
 574    V2(AgentSettingsContentV2),
 575}
 576
 577impl Default for VersionedAgentSettingsContent {
 578    fn default() -> Self {
 579        Self::V2(AgentSettingsContentV2 {
 580            enabled: None,
 581            button: None,
 582            dock: None,
 583            default_width: None,
 584            default_height: None,
 585            default_model: None,
 586            inline_assistant_model: None,
 587            commit_message_model: None,
 588            thread_summary_model: None,
 589            inline_alternatives: None,
 590            default_profile: None,
 591            default_view: None,
 592            profiles: None,
 593            always_allow_tool_actions: None,
 594            notify_when_agent_waiting: None,
 595            stream_edits: None,
 596            single_file_review: None,
 597            model_parameters: Vec::new(),
 598            preferred_completion_mode: None,
 599            enable_feedback: None,
 600            play_sound_when_agent_done: None,
 601        })
 602    }
 603}
 604
 605#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug, Default)]
 606#[schemars(deny_unknown_fields)]
 607pub struct AgentSettingsContentV2 {
 608    /// Whether the Agent is enabled.
 609    ///
 610    /// Default: true
 611    enabled: Option<bool>,
 612    /// Whether to show the agent panel button in the status bar.
 613    ///
 614    /// Default: true
 615    button: Option<bool>,
 616    /// Where to dock the agent panel.
 617    ///
 618    /// Default: right
 619    dock: Option<AgentDockPosition>,
 620    /// Default width in pixels when the agent panel is docked to the left or right.
 621    ///
 622    /// Default: 640
 623    default_width: Option<f32>,
 624    /// Default height in pixels when the agent panel is docked to the bottom.
 625    ///
 626    /// Default: 320
 627    default_height: Option<f32>,
 628    /// The default model to use when creating new chats and for other features when a specific model is not specified.
 629    default_model: Option<LanguageModelSelection>,
 630    /// Model to use for the inline assistant. Defaults to default_model when not specified.
 631    inline_assistant_model: Option<LanguageModelSelection>,
 632    /// Model to use for generating git commit messages. Defaults to default_model when not specified.
 633    commit_message_model: Option<LanguageModelSelection>,
 634    /// Model to use for generating thread summaries. Defaults to default_model when not specified.
 635    thread_summary_model: Option<LanguageModelSelection>,
 636    /// Additional models with which to generate alternatives when performing inline assists.
 637    inline_alternatives: Option<Vec<LanguageModelSelection>>,
 638    /// The default profile to use in the Agent.
 639    ///
 640    /// Default: write
 641    default_profile: Option<AgentProfileId>,
 642    /// Which view type to show by default in the agent panel.
 643    ///
 644    /// Default: "thread"
 645    default_view: Option<DefaultView>,
 646    /// The available agent profiles.
 647    pub profiles: Option<IndexMap<AgentProfileId, AgentProfileContent>>,
 648    /// Whenever a tool action would normally wait for your confirmation
 649    /// that you allow it, always choose to allow it.
 650    ///
 651    /// Default: false
 652    always_allow_tool_actions: Option<bool>,
 653    /// Where to show a popup notification when the agent is waiting for user input.
 654    ///
 655    /// Default: "primary_screen"
 656    notify_when_agent_waiting: Option<NotifyWhenAgentWaiting>,
 657    /// Whether to play a sound when the agent has either completed its response, or needs user input.
 658    ///
 659    /// Default: false
 660    play_sound_when_agent_done: Option<bool>,
 661    /// Whether to stream edits from the agent as they are received.
 662    ///
 663    /// Default: false
 664    stream_edits: Option<bool>,
 665    /// Whether to display agent edits in single-file editors in addition to the review multibuffer pane.
 666    ///
 667    /// Default: true
 668    single_file_review: Option<bool>,
 669    /// Additional parameters for language model requests. When making a request
 670    /// to a model, parameters will be taken from the last entry in this list
 671    /// that matches the model's provider and name. In each entry, both provider
 672    /// and model are optional, so that you can specify parameters for either
 673    /// one.
 674    ///
 675    /// Default: []
 676    #[serde(default)]
 677    model_parameters: Vec<LanguageModelParameters>,
 678    /// What completion mode to enable for new threads
 679    ///
 680    /// Default: normal
 681    preferred_completion_mode: Option<CompletionMode>,
 682    /// Whether to show thumb buttons for feedback in the agent panel.
 683    ///
 684    /// Default: true
 685    enable_feedback: Option<bool>,
 686}
 687
 688#[derive(Clone, Copy, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Default)]
 689#[serde(rename_all = "snake_case")]
 690pub enum CompletionMode {
 691    #[default]
 692    Normal,
 693    #[serde(alias = "max")]
 694    Burn,
 695}
 696
 697impl From<CompletionMode> for zed_llm_client::CompletionMode {
 698    fn from(value: CompletionMode) -> Self {
 699        match value {
 700            CompletionMode::Normal => zed_llm_client::CompletionMode::Normal,
 701            CompletionMode::Burn => zed_llm_client::CompletionMode::Max,
 702        }
 703    }
 704}
 705
 706#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq)]
 707pub struct LanguageModelSelection {
 708    pub provider: LanguageModelProviderSetting,
 709    pub model: String,
 710}
 711
 712#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 713pub struct LanguageModelProviderSetting(pub String);
 714
 715impl JsonSchema for LanguageModelProviderSetting {
 716    fn schema_name() -> String {
 717        "LanguageModelProviderSetting".into()
 718    }
 719
 720    fn json_schema(_: &mut schemars::r#gen::SchemaGenerator) -> Schema {
 721        schemars::schema::SchemaObject {
 722            enum_values: Some(vec![
 723                "anthropic".into(),
 724                "amazon-bedrock".into(),
 725                "google".into(),
 726                "lmstudio".into(),
 727                "ollama".into(),
 728                "openai".into(),
 729                "zed.dev".into(),
 730                "copilot_chat".into(),
 731                "deepseek".into(),
 732                "mistral".into(),
 733            ]),
 734            ..Default::default()
 735        }
 736        .into()
 737    }
 738}
 739
 740impl From<String> for LanguageModelProviderSetting {
 741    fn from(provider: String) -> Self {
 742        Self(provider)
 743    }
 744}
 745
 746impl From<&str> for LanguageModelProviderSetting {
 747    fn from(provider: &str) -> Self {
 748        Self(provider.to_string())
 749    }
 750}
 751
 752impl Default for LanguageModelSelection {
 753    fn default() -> Self {
 754        Self {
 755            provider: LanguageModelProviderSetting("openai".to_string()),
 756            model: "gpt-4".to_string(),
 757        }
 758    }
 759}
 760
 761#[derive(Debug, PartialEq, Clone, Serialize, Deserialize, JsonSchema)]
 762pub struct AgentProfileContent {
 763    pub name: Arc<str>,
 764    #[serde(default)]
 765    pub tools: IndexMap<Arc<str>, bool>,
 766    /// Whether all context servers are enabled by default.
 767    pub enable_all_context_servers: Option<bool>,
 768    #[serde(default)]
 769    pub context_servers: IndexMap<Arc<str>, ContextServerPresetContent>,
 770}
 771
 772#[derive(Debug, PartialEq, Clone, Default, Serialize, Deserialize, JsonSchema)]
 773pub struct ContextServerPresetContent {
 774    pub tools: IndexMap<Arc<str>, bool>,
 775}
 776
 777#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug)]
 778#[schemars(deny_unknown_fields)]
 779pub struct AgentSettingsContentV1 {
 780    /// Whether the Agent is enabled.
 781    ///
 782    /// Default: true
 783    enabled: Option<bool>,
 784    /// Whether to show the Agent panel button in the status bar.
 785    ///
 786    /// Default: true
 787    button: Option<bool>,
 788    /// Where to dock the Agent.
 789    ///
 790    /// Default: right
 791    dock: Option<AgentDockPosition>,
 792    /// Default width in pixels when the Agent is docked to the left or right.
 793    ///
 794    /// Default: 640
 795    default_width: Option<f32>,
 796    /// Default height in pixels when the Agent is docked to the bottom.
 797    ///
 798    /// Default: 320
 799    default_height: Option<f32>,
 800    /// The provider of the Agent service.
 801    ///
 802    /// This can be "openai", "anthropic", "ollama", "lmstudio", "deepseek", "zed.dev"
 803    /// each with their respective default models and configurations.
 804    provider: Option<AgentProviderContentV1>,
 805}
 806
 807#[derive(Clone, Serialize, Deserialize, JsonSchema, Debug)]
 808#[schemars(deny_unknown_fields)]
 809pub struct LegacyAgentSettingsContent {
 810    /// Whether to show the Agent panel button in the status bar.
 811    ///
 812    /// Default: true
 813    pub button: Option<bool>,
 814    /// Where to dock the Agent.
 815    ///
 816    /// Default: right
 817    pub dock: Option<AgentDockPosition>,
 818    /// Default width in pixels when the Agent is docked to the left or right.
 819    ///
 820    /// Default: 640
 821    pub default_width: Option<f32>,
 822    /// Default height in pixels when the Agent is docked to the bottom.
 823    ///
 824    /// Default: 320
 825    pub default_height: Option<f32>,
 826    /// The default OpenAI model to use when creating new chats.
 827    ///
 828    /// Default: gpt-4-1106-preview
 829    pub default_open_ai_model: Option<OpenAiModel>,
 830    /// OpenAI API base URL to use when creating new chats.
 831    ///
 832    /// Default: <https://api.openai.com/v1>
 833    pub openai_api_url: Option<String>,
 834}
 835
 836impl Settings for AgentSettings {
 837    const KEY: Option<&'static str> = Some("agent");
 838
 839    const FALLBACK_KEY: Option<&'static str> = Some("assistant");
 840
 841    const PRESERVED_KEYS: Option<&'static [&'static str]> = Some(&["version"]);
 842
 843    type FileContent = AgentSettingsContent;
 844
 845    fn load(
 846        sources: SettingsSources<Self::FileContent>,
 847        _: &mut gpui::App,
 848    ) -> anyhow::Result<Self> {
 849        let mut settings = AgentSettings::default();
 850
 851        for value in sources.defaults_and_customizations() {
 852            if value.is_version_outdated() {
 853                settings.using_outdated_settings_version = true;
 854            }
 855
 856            let value = value.upgrade();
 857            merge(&mut settings.enabled, value.enabled);
 858            merge(&mut settings.button, value.button);
 859            merge(&mut settings.dock, value.dock);
 860            merge(
 861                &mut settings.default_width,
 862                value.default_width.map(Into::into),
 863            );
 864            merge(
 865                &mut settings.default_height,
 866                value.default_height.map(Into::into),
 867            );
 868            merge(&mut settings.default_model, value.default_model);
 869            settings.inline_assistant_model = value
 870                .inline_assistant_model
 871                .or(settings.inline_assistant_model.take());
 872            settings.commit_message_model = value
 873                .commit_message_model
 874                .or(settings.commit_message_model.take());
 875            settings.thread_summary_model = value
 876                .thread_summary_model
 877                .or(settings.thread_summary_model.take());
 878            merge(&mut settings.inline_alternatives, value.inline_alternatives);
 879            merge(
 880                &mut settings.always_allow_tool_actions,
 881                value.always_allow_tool_actions,
 882            );
 883            merge(
 884                &mut settings.notify_when_agent_waiting,
 885                value.notify_when_agent_waiting,
 886            );
 887            merge(
 888                &mut settings.play_sound_when_agent_done,
 889                value.play_sound_when_agent_done,
 890            );
 891            merge(&mut settings.stream_edits, value.stream_edits);
 892            merge(&mut settings.single_file_review, value.single_file_review);
 893            merge(&mut settings.default_profile, value.default_profile);
 894            merge(&mut settings.default_view, value.default_view);
 895            merge(
 896                &mut settings.preferred_completion_mode,
 897                value.preferred_completion_mode,
 898            );
 899            merge(&mut settings.enable_feedback, value.enable_feedback);
 900
 901            settings
 902                .model_parameters
 903                .extend_from_slice(&value.model_parameters);
 904
 905            if let Some(profiles) = value.profiles {
 906                settings
 907                    .profiles
 908                    .extend(profiles.into_iter().map(|(id, profile)| {
 909                        (
 910                            id,
 911                            AgentProfile {
 912                                name: profile.name.into(),
 913                                tools: profile.tools,
 914                                enable_all_context_servers: profile
 915                                    .enable_all_context_servers
 916                                    .unwrap_or_default(),
 917                                context_servers: profile
 918                                    .context_servers
 919                                    .into_iter()
 920                                    .map(|(context_server_id, preset)| {
 921                                        (
 922                                            context_server_id,
 923                                            ContextServerPreset {
 924                                                tools: preset.tools.clone(),
 925                                            },
 926                                        )
 927                                    })
 928                                    .collect(),
 929                            },
 930                        )
 931                    }));
 932            }
 933        }
 934
 935        Ok(settings)
 936    }
 937
 938    fn import_from_vscode(vscode: &settings::VsCodeSettings, current: &mut Self::FileContent) {
 939        if let Some(b) = vscode
 940            .read_value("chat.agent.enabled")
 941            .and_then(|b| b.as_bool())
 942        {
 943            match &mut current.inner {
 944                Some(AgentSettingsContentInner::Versioned(versioned)) => match versioned.as_mut() {
 945                    VersionedAgentSettingsContent::V1(setting) => {
 946                        setting.enabled = Some(b);
 947                        setting.button = Some(b);
 948                    }
 949
 950                    VersionedAgentSettingsContent::V2(setting) => {
 951                        setting.enabled = Some(b);
 952                        setting.button = Some(b);
 953                    }
 954                },
 955                Some(AgentSettingsContentInner::Legacy(setting)) => setting.button = Some(b),
 956                None => {
 957                    current.inner =
 958                        Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
 959                            enabled: Some(b),
 960                            button: Some(b),
 961                            ..Default::default()
 962                        }));
 963                }
 964            }
 965        }
 966    }
 967}
 968
 969fn merge<T>(target: &mut T, value: Option<T>) {
 970    if let Some(value) = value {
 971        *target = value;
 972    }
 973}
 974
 975#[cfg(test)]
 976mod tests {
 977    use fs::Fs;
 978    use gpui::{ReadGlobal, TestAppContext};
 979    use settings::SettingsStore;
 980
 981    use super::*;
 982
 983    #[gpui::test]
 984    async fn test_deserialize_agent_settings_with_version(cx: &mut TestAppContext) {
 985        let fs = fs::FakeFs::new(cx.executor().clone());
 986        fs.create_dir(paths::settings_file().parent().unwrap())
 987            .await
 988            .unwrap();
 989
 990        cx.update(|cx| {
 991            let test_settings = settings::SettingsStore::test(cx);
 992            cx.set_global(test_settings);
 993            AgentSettings::register(cx);
 994        });
 995
 996        cx.update(|cx| {
 997            assert!(!AgentSettings::get_global(cx).using_outdated_settings_version);
 998            assert_eq!(
 999                AgentSettings::get_global(cx).default_model,
1000                LanguageModelSelection {
1001                    provider: "zed.dev".into(),
1002                    model: "claude-sonnet-4".into(),
1003                }
1004            );
1005        });
1006
1007        cx.update(|cx| {
1008            settings::SettingsStore::global(cx).update_settings_file::<AgentSettings>(
1009                fs.clone(),
1010                |settings, _| {
1011                    *settings = AgentSettingsContent {
1012                        inner: Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
1013                            default_model: Some(LanguageModelSelection {
1014                                provider: "test-provider".into(),
1015                                model: "gpt-99".into(),
1016                            }),
1017                            inline_assistant_model: None,
1018                            commit_message_model: None,
1019                            thread_summary_model: None,
1020                            inline_alternatives: None,
1021                            enabled: None,
1022                            button: None,
1023                            dock: None,
1024                            default_width: None,
1025                            default_height: None,
1026                            default_profile: None,
1027                            default_view: None,
1028                            profiles: None,
1029                            always_allow_tool_actions: None,
1030                            play_sound_when_agent_done: None,
1031                            notify_when_agent_waiting: None,
1032                            stream_edits: None,
1033                            single_file_review: None,
1034                            enable_feedback: None,
1035                            model_parameters: Vec::new(),
1036                            preferred_completion_mode: None,
1037                        })),
1038                    }
1039                },
1040            );
1041        });
1042
1043        cx.run_until_parked();
1044
1045        let raw_settings_value = fs.load(paths::settings_file()).await.unwrap();
1046        assert!(raw_settings_value.contains(r#""version": "2""#));
1047
1048        #[derive(Debug, Deserialize)]
1049        struct AgentSettingsTest {
1050            agent: AgentSettingsContent,
1051        }
1052
1053        let agent_settings: AgentSettingsTest =
1054            serde_json_lenient::from_str(&raw_settings_value).unwrap();
1055
1056        assert!(!agent_settings.agent.is_version_outdated());
1057    }
1058
1059    #[gpui::test]
1060    async fn test_load_settings_from_old_key(cx: &mut TestAppContext) {
1061        let fs = fs::FakeFs::new(cx.executor().clone());
1062        fs.create_dir(paths::settings_file().parent().unwrap())
1063            .await
1064            .unwrap();
1065
1066        cx.update(|cx| {
1067            let mut test_settings = settings::SettingsStore::test(cx);
1068            let user_settings_content = r#"{
1069            "assistant": {
1070                "enabled": true,
1071                "version": "2",
1072                "default_model": {
1073                  "provider": "zed.dev",
1074                  "model": "gpt-99"
1075                },
1076            }}"#;
1077            test_settings
1078                .set_user_settings(user_settings_content, cx)
1079                .unwrap();
1080            cx.set_global(test_settings);
1081            AgentSettings::register(cx);
1082        });
1083
1084        cx.run_until_parked();
1085
1086        let agent_settings = cx.update(|cx| AgentSettings::get_global(cx).clone());
1087        assert!(agent_settings.enabled);
1088        assert!(!agent_settings.using_outdated_settings_version);
1089        assert_eq!(agent_settings.default_model.model, "gpt-99");
1090
1091        cx.update_global::<SettingsStore, _>(|settings_store, cx| {
1092            settings_store.update_user_settings::<AgentSettings>(cx, |settings| {
1093                *settings = AgentSettingsContent {
1094                    inner: Some(AgentSettingsContentInner::for_v2(AgentSettingsContentV2 {
1095                        enabled: Some(false),
1096                        default_model: Some(LanguageModelSelection {
1097                            provider: "xai".to_owned().into(),
1098                            model: "grok".to_owned(),
1099                        }),
1100                        ..Default::default()
1101                    })),
1102                };
1103            });
1104        });
1105
1106        cx.run_until_parked();
1107
1108        let settings = cx.update(|cx| SettingsStore::global(cx).raw_user_settings().clone());
1109
1110        #[derive(Debug, Deserialize)]
1111        struct AgentSettingsTest {
1112            assistant: AgentSettingsContent,
1113            agent: Option<serde_json_lenient::Value>,
1114        }
1115
1116        let agent_settings: AgentSettingsTest = serde_json::from_value(settings).unwrap();
1117        assert!(agent_settings.agent.is_none());
1118    }
1119}