feat(agent): adds root and slash command to set user defined default (#2420)

Author: dingfeli

crates/chat-cli/src/cli/agent/mod.rs

@@ -71,6 +71,8 @@ use crate::util::{
     directories,
 };
 
+const DEFAULT_AGENT_NAME: &str = "q_cli_default";
+
 #[derive(Debug, Error)]
 pub enum AgentConfigError {
     #[error("Json supplied at {} is invalid: {}", path.display(), error)]
@@ -86,8 +88,6 @@ pub enum AgentConfigError {
     Directories(#[from] util::directories::DirectoryError),
     #[error("Encountered io error: {0}")]
     Io(#[from] std::io::Error),
-    #[error("Agent path missing file name")]
-    MissingFilename,
     #[error("Failed to parse legacy mcp config: {0}")]
     BadLegacyMcpConfig(#[from] eyre::Report),
 }
@@ -120,13 +120,14 @@ pub enum AgentConfigError {
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 #[schemars(description = "An Agent is a declarative way of configuring a given instance of q chat.")]
 pub struct Agent {
-    /// Agent names are optional. If they are not provided they are derived from the file name
-    #[serde(default)]
+    /// Name of the agent
     pub name: String,
+    /// Version of the agent config
+    pub version: String,
     /// This field is not model facing and is mostly here for users to discern between agents
     #[serde(default)]
     pub description: Option<String>,
-    /// (NOT YET IMPLEMENTED) The intention for this field is to provide high level context to the
+    /// The intention for this field is to provide high level context to the
     /// agent. This should be seen as the same category of context as a system prompt.
     #[serde(default)]
     pub prompt: Option<String>,
@@ -167,7 +168,8 @@ pub struct Agent {
 impl Default for Agent {
     fn default() -> Self {
         Self {
-            name: "default".to_string(),
+            name: DEFAULT_AGENT_NAME.to_string(),
+            version: "0.1.0".to_string(),
             description: Some("Default agent".to_string()),
             prompt: Default::default(),
             mcp_servers: Default::default(),
@@ -205,21 +207,10 @@ impl Agent {
 
     /// This function mutates the agent to a state that is usable for runtime.
     /// Practically this means to convert some of the fields value to their usable counterpart.
-    /// For example, we populate the agent with its file name, convert the mcp array to actual
-    /// mcp config and populate the agent file path.
+    /// For example, converting the mcp array to actual mcp config and populate the agent file path.
     fn thaw(&mut self, path: &Path, global_mcp_config: Option<&McpServerConfig>) -> Result<(), AgentConfigError> {
         let Self { mcp_servers, .. } = self;
 
-        if self.name.is_empty() {
-            let name = path
-                .file_stem()
-                .ok_or(AgentConfigError::MissingFilename)?
-                .to_string_lossy()
-                .to_string();
-
-            self.name = name;
-        }
-
         self.path = Some(path.to_path_buf());
 
         if let (true, Some(global_mcp_config)) = (self.use_legacy_mcp_json, global_mcp_config) {
@@ -643,7 +634,7 @@ impl Agents {
                 agent
             });
 
-            "default".to_string()
+            DEFAULT_AGENT_NAME.to_string()
         };
 
         let _ = output.flush();
@@ -802,6 +793,8 @@ mod tests {
 
     const INPUT: &str = r#"
             {
+              "name": "some_agent",
+              "version": "0.1.0",
               "description": "My developer agent is used for small development tasks like solving open issues.",
               "prompt": "You are a principal developer who uses multiple agents to accomplish difficult engineering tasks",
               "mcpServers": {
@@ -843,11 +836,12 @@ mod tests {
         assert!(collection.get_active().is_none());
 
         let agent = Agent::default();
-        collection.agents.insert("default".to_string(), agent);
-        collection.active_idx = "default".to_string();
+        let agent_name = agent.name.clone();
+        collection.agents.insert(agent_name.clone(), agent);
+        collection.active_idx = agent_name.clone();
 
         assert!(collection.get_active().is_some());
-        assert_eq!(collection.get_active().unwrap().name, "default");
+        assert_eq!(collection.get_active().unwrap().name, agent_name);
     }
 
     #[test]

crates/chat-cli/src/cli/agent/root_command_args.rs

@@ -70,6 +70,11 @@ pub enum AgentSubcommands {
         #[arg(long)]
         force: bool,
     },
+    /// Define a default agent to use when q chat launches
+    SetDefault {
+        #[arg(long, short)]
+        name: String,
+    },
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Default, Args)]
@@ -262,6 +267,35 @@ impl AgentArgs {
                     },
                 }
             },
+            Some(AgentSubcommands::SetDefault { name }) => {
+                let mut agents = Agents::load(os, None, true, &mut stderr).await.0;
+                match agents.switch(&name) {
+                    Ok(agent) => {
+                        os.database
+                            .settings
+                            .set(Setting::ChatDefaultAgent, agent.name.clone())
+                            .await?;
+
+                        let _ = queue!(
+                            stderr,
+                            style::SetForegroundColor(Color::Green),
+                            style::Print("✓ Default agent set to '"),
+                            style::Print(&agent.name),
+                            style::Print("'. This will take effect the next time q chat is launched.\n"),
+                            style::ResetColor,
+                        );
+                    },
+                    Err(e) => {
+                        let _ = queue!(
+                            stderr,
+                            style::SetForegroundColor(Color::Red),
+                            style::Print("Error: "),
+                            style::ResetColor,
+                            style::Print(format!("Failed to set default agent: {e}\n")),
+                        );
+                    },
+                }
+            },
         }
 
         Ok(ExitCode::SUCCESS)
@@ -301,11 +335,17 @@ pub async fn create_agent(
     }
 
     let prepopulated_content = if let Some(from) = from {
-        let agent_to_copy = agents.switch(from.as_str())?;
-        agent_to_copy.to_str_pretty()?
+        let mut agent_to_copy = agents.switch(from.as_str())?.clone();
+        agent_to_copy.name = name.clone();
+        agent_to_copy
     } else {
-        Default::default()
-    };
+        Agent {
+            name: name.clone(),
+            description: Some(Default::default()),
+            ..Default::default()
+        }
+    }
+    .to_str_pretty()?;
     let path_with_file_name = path.join(format!("{name}.json"));
 
     if !path.exists() {

crates/chat-cli/src/cli/chat/cli/profile.rs

@@ -33,6 +33,7 @@ use crate::cli::chat::{
     ChatSession,
     ChatState,
 };
+use crate::database::settings::Setting;
 use crate::os::Os;
 use crate::util::directories::chat_global_agent_path;
 
@@ -82,6 +83,11 @@ pub enum AgentSubcommand {
     },
     /// Show agent config schema
     Schema,
+    /// Define a default agent to use when q chat launches
+    SetDefault {
+        #[arg(long, short)]
+        name: String,
+    },
 }
 
 impl AgentSubcommand {
@@ -225,6 +231,33 @@ impl AgentSubcommand {
                     style::SetAttribute(Attribute::Reset)
                 )?;
             },
+            Self::SetDefault { name } => match session.conversation.agents.agents.get(&name) {
+                Some(agent) => {
+                    os.database
+                        .settings
+                        .set(Setting::ChatDefaultAgent, agent.name.clone())
+                        .await
+                        .map_err(|e| ChatError::Custom(e.to_string().into()))?;
+
+                    execute!(
+                        session.stderr,
+                        style::SetForegroundColor(Color::Green),
+                        style::Print("✓ Default agent set to '"),
+                        style::Print(&agent.name),
+                        style::Print("'. This will take effect the next time q chat is launched.\n"),
+                        style::ResetColor,
+                    )?;
+                },
+                None => {
+                    execute!(
+                        session.stderr,
+                        style::SetForegroundColor(Color::Red),
+                        style::Print("Error: "),
+                        style::ResetColor,
+                        style::Print(format!("No agent with name {name} found\n")),
+                    )?;
+                },
+            },
         }
 
         Ok(ChatState::PromptUser {
@@ -240,6 +273,7 @@ impl AgentSubcommand {
             Self::Set { .. } => "set",
             Self::Rename { .. } => "rename",
             Self::Schema => "schema",
+            Self::SetDefault { .. } => "set_default",
         }
     }
 }

docs/agent-format.md

@@ -18,7 +18,7 @@ Every agent configuration file can include the following sections:
 
 ## Name Field
 
-The `name` field specifies the name of the agent. This is used for identification and display purposes. If not specified, the name is derived from the filename (without the `.json` extension).
+The `name` field specifies the name of the agent. This is used for identification and display purposes. 
 
 ```json
 {
@@ -28,6 +28,17 @@ The `name` field specifies the name of the agent. This is used for identificatio
 
 Note: While this field can be included in the configuration file, it will be overridden by the filename when the agent is loaded.
 
+## Version Field
+
+The `version` field specifies the version of the agent config. This is currently not being utilized though you must specify it.
+Currently, the default version is "0.1.0"
+
+```json
+{
+  "version": "0.1.0"
+}
+```
+
 ## Description Field
 
 The `description` field provides a description of what the agent does. This is primarily for human readability and helps users distinguish between different agents.