Add more tools, compaction support

Author: brandonskiser

Cargo.lock

@@ -43,6 +43,7 @@ http.workspace = true
 http-body-util.workspace = true
 hyper.workspace = true
 hyper-util.workspace = true
+libc.workspace = true
 percent-encoding.workspace = true
 pin-project-lite = "0.2.16"
 r2d2.workspace = true
@@ -63,6 +64,7 @@ sha2.workspace = true
 shellexpand.workspace = true
 strum.workspace = true
 syntect = "5.2.0"
+sysinfo.workspace = true
 textwrap = "0.16.2"
 thiserror.workspace = true
 time.workspace = true
@@ -76,6 +78,7 @@ tui-textarea = "0.7.0"
 url.workspace = true
 uuid.workspace = true
 webpki-roots.workspace = true
+whoami.workspace = true
 
 [target.'cfg(target_os = "macos")'.dependencies]
 objc2.workspace = true

crates/agent/Cargo.toml

@@ -166,7 +166,7 @@ impl Default for AgentConfigV2025_08_22 {
             name: BUILTIN_VIBER_AGENT_NAME.to_string(),
             description: Some("The default agent for Q CLI".to_string()),
             system_prompt: Some("You are Q, an expert programmer dedicated to becoming the greatest vibe-coding assistant in the world.".to_string()),
-            tools: vec![BuiltInToolName::FileRead.to_string(), BuiltInToolName::FileWrite.to_string()],
+            tools: vec!["@builtin".to_string()],
             tool_settings: Default::default(),
             tool_aliases: Default::default(),
             tool_schema: Default::default(),
@@ -195,8 +195,8 @@ pub struct FileReadSettings {
 
 #[derive(Debug, Clone, Default, Serialize, Deserialize, JsonSchema)]
 pub struct FileWriteSettings {
-    allowed_paths: Vec<String>,
-    denied_paths: Vec<String>,
+    pub allowed_paths: Vec<String>,
+    pub denied_paths: Vec<String>,
 }
 
 /// This mirrors claude's config set up.

crates/agent/src/agent/agent_config/definitions.rs

@@ -90,17 +90,22 @@ impl std::fmt::Display for AgentLoopId {
 pub enum LoopState {
     #[default]
     Idle,
-    /// A request is currently being sent to the model
+    /// A request is currently being sent to the model.
+    ///
+    /// The loop is unable to handle new requests while in this state.
     SendingRequest,
-    /// A model response is currently being consumed
+    /// A model response is currently being consumed.
+    ///
+    /// The loop is unable to handle new requests while in this state.
     ConsumingResponse,
-    /// The loop is waiting for tool use result(s) to be provided
+    /// The loop is waiting for tool use result(s) to be provided.
     PendingToolUseResults,
     /// The agent loop has completed all processing, and no pending work is left to do.
     ///
-    /// This is the final state of the loop - no further requests can be made.
+    /// This is generally the final state of the loop. If another request is sent, then the user
+    /// turn will be continued for another cycle.
     UserTurnEnded,
-    /// An error occurred that requires manual intervention
+    /// An error occurred that requires manual intervention.
     Errored,
 }
 
@@ -176,13 +181,13 @@ impl AgentLoop {
         let loop_req_tx = self.loop_req_tx.take().expect("loop_req_tx should exist");
         let handle = tokio::spawn(async move {
             info!("agent loop start");
-            self.run().await;
+            self.main_loop().await;
             info!("agent loop end");
         });
         AgentLoopHandle::new(id_clone, loop_req_tx, loop_event_rx, handle)
     }
 
-    async fn run(mut self) {
+    async fn main_loop(mut self) {
         loop {
             tokio::select! {
                 // Branch for handling agent loop messages
@@ -261,11 +266,11 @@ impl AgentLoop {
 
                 // Ensure we are in a state that can handle a new request.
                 match self.execution_state {
-                    LoopState::Idle | LoopState::PendingToolUseResults => {},
-                    LoopState::UserTurnEnded => {
-                        // TODO - custom message?
-                        return Err(AgentLoopResponseError::AgentLoopExited);
-                    },
+                    LoopState::Idle | LoopState::Errored | LoopState::PendingToolUseResults => {},
+                    LoopState::UserTurnEnded => {},
+                    // LoopState::UserTurnEnded => {
+                    //     return Err(AgentLoopResponseError::AgentLoopExited);
+                    // },
                     other => {
                         error!(
                             ?other,

crates/agent/src/agent/agent_loop/mod.rs

@@ -111,6 +111,13 @@ pub enum AgentLoopEventKind {
     /// A valid tool use was received
     ToolUse(ToolUseBlock),
     /// A single request/response stream has completed processing.
+    ///
+    /// When emitted, the agent loop is in either of the states:
+    /// 1. User turn is ongoing (due to tool uses or a stream error), and the loop is ready to
+    ///    receive a new request.
+    /// 2. User turn has ended, in which case a [AgentLoopEventKind::UserTurnEnd] event is emitted
+    ///    afterwards. The loop is still able to receive new requests which will continue the user
+    ///    turn.
     ResponseStreamEnd {
         /// The result of having parsed the entire stream.
         ///
@@ -120,12 +127,13 @@ pub enum AgentLoopEventKind {
         /// Metadata about the stream.
         metadata: StreamMetadata,
     },
-    /// The agent loop has changed states
-    LoopStateChange { from: LoopState, to: LoopState },
     /// Metadata for the entire user turn.
     ///
-    /// This is the last event that the agent loop will emit.
+    /// This is the last event that the agent loop will emit, unless another request is sent that
+    /// continues the turn.
     UserTurnEnd(UserTurnMetadata),
+    /// The agent loop has changed states
+    LoopStateChange { from: LoopState, to: LoopState },
     /// Low level event. Generally only useful for [AgentLoop].
     StreamEvent(StreamEvent),
     /// Low level event. Generally only useful for [AgentLoop].

crates/agent/src/agent/agent_loop/protocol.rs

@@ -253,18 +253,25 @@ pub enum ContentBlock {
     Image(ImageBlock),
 }
 
+impl From<String> for ContentBlock {
+    fn from(value: String) -> Self {
+        Self::Text(value)
+    }
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(rename_all = "lowercase")]
 pub struct ImageBlock {
     pub format: ImageFormat,
     pub source: ImageSource,
 }
 
-#[derive(Debug, Clone, Copy, Serialize, Deserialize, strum::EnumString, strum::Display)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, strum::EnumString, strum::Display)]
 #[serde(rename_all = "lowercase")]
 #[strum(serialize_all = "lowercase")]
 pub enum ImageFormat {
     Gif,
+    #[serde(alias = "jpg")]
     Jpeg,
     Png,
     Webp,
@@ -438,9 +445,21 @@ pub struct MetadataService {
 
 #[cfg(test)]
 mod tests {
+    use std::str::FromStr;
+
     use super::*;
     use crate::api_client::error::ConverseStreamErrorKind;
 
+    macro_rules! test_ser_deser {
+        ($ty:ident, $variant:expr, $text:expr) => {
+            let quoted = format!("\"{}\"", $text);
+            assert_eq!(quoted, serde_json::to_string(&$variant).unwrap());
+            assert_eq!($variant, serde_json::from_str(&quoted).unwrap());
+            assert_eq!($variant, $ty::from_str($text).unwrap());
+            assert_eq!($text, $variant.to_string());
+        };
+    }
+
     #[test]
     fn test_other_stream_err_downcasting() {
         let err = StreamError::new(StreamErrorKind::Interrupted).with_source(Arc::new(ConverseStreamError::new(
@@ -453,4 +472,13 @@ mod tests {
                 .is_some_and(|r| matches!(r.kind, ConverseStreamErrorKind::ModelOverloadedError))
         );
     }
+
+    #[test]
+    fn test_image_format_ser_deser() {
+        test_ser_deser!(ImageFormat, ImageFormat::Gif, "gif");
+        test_ser_deser!(ImageFormat, ImageFormat::Png, "png");
+        test_ser_deser!(ImageFormat, ImageFormat::Webp, "webp");
+        test_ser_deser!(ImageFormat, ImageFormat::Jpeg, "jpeg");
+        assert_eq!(ImageFormat::from_str("jpg").unwrap(), ImageFormat::Jpeg);
+    }
 }

crates/agent/src/agent/agent_loop/types.rs

@@ -0,0 +1,112 @@
+use serde::{
+    Deserialize,
+    Serialize,
+};
+
+use super::agent_loop::types::Message;
+use super::types::ConversationState;
+use super::{
+    CONTEXT_ENTRY_END_HEADER,
+    CONTEXT_ENTRY_START_HEADER,
+};
+
+/// State associated with an agent compacting its conversation state.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct CompactingState {
+    /// The user message that failed to be sent due to the context window overflowing, if
+    /// available.
+    ///
+    /// If this is [Some], then this indicates that auto-compaction was applied. See
+    /// [super::types::AgentSettings::auto_compact].
+    pub last_user_message: Option<Message>,
+    /// Strategy used when creating the compact request.
+    pub strategy: CompactStrategy,
+    /// The conversation state currently being summarized
+    pub conversation: ConversationState,
+    // TODO - result sender?
+    // #[serde(skip)]
+    // pub result_tx: Option<oneshot::Sender<()>>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct CompactStrategy {
+    /// Number of user/assistant pairs to exclude from the history as part of compaction.
+    pub messages_to_exclude: usize,
+    /// Whether or not to truncate large messages in the history.
+    pub truncate_large_messages: bool,
+    /// Maximum allowed size of messages in the conversation history.
+    pub max_message_length: usize,
+}
+
+impl Default for CompactStrategy {
+    fn default() -> Self {
+        Self {
+            messages_to_exclude: 0,
+            truncate_large_messages: false,
+            max_message_length: 25_000,
+        }
+    }
+}
+
+pub fn create_summary_prompt(custom_prompt: Option<String>, latest_summary: Option<impl AsRef<str>>) -> String {
+    let mut summary_content = match custom_prompt {
+        Some(custom_prompt) => {
+            // Make the custom instructions much more prominent and directive
+            format!(
+                "[SYSTEM NOTE: This is an automated summarization request, not from the user]\n\n\
+                FORMAT REQUIREMENTS: Create a structured, concise summary in bullet-point format. DO NOT respond conversationally. DO NOT address the user directly.\n\n\
+                IMPORTANT CUSTOM INSTRUCTION: {}\n\n\
+                Your task is to create a structured summary document containing:\n\
+                1) A bullet-point list of key topics/questions covered\n\
+                2) Bullet points for all significant tools executed and their results\n\
+                3) Bullet points for any code or technical information shared\n\
+                4) A section of key insights gained\n\n\
+                5) REQUIRED: the ID of the currently loaded todo list, if any\n\n\
+                FORMAT THE SUMMARY IN THIRD PERSON, NOT AS A DIRECT RESPONSE. Example format:\n\n\
+                ## CONVERSATION SUMMARY\n\
+                * Topic 1: Key information\n\
+                * Topic 2: Key information\n\n\
+                ## TOOLS EXECUTED\n\
+                * Tool X: Result Y\n\n\
+                ## TODO ID\n\
+                * <id>\n\n\
+                Remember this is a DOCUMENT not a chat response. The custom instruction above modifies what to prioritize.\n\
+                FILTER OUT CHAT CONVENTIONS (greetings, offers to help, etc).",
+                custom_prompt
+            )
+        },
+        None => {
+            // Default prompt
+            "[SYSTEM NOTE: This is an automated summarization request, not from the user]\n\n\
+                FORMAT REQUIREMENTS: Create a structured, concise summary in bullet-point format. DO NOT respond conversationally. DO NOT address the user directly.\n\n\
+                Your task is to create a structured summary document containing:\n\
+                1) A bullet-point list of key topics/questions covered\n\
+                2) Bullet points for all significant tools executed and their results\n\
+                3) Bullet points for any code or technical information shared\n\
+                4) A section of key insights gained\n\n\
+                5) REQUIRED: the ID of the currently loaded todo list, if any\n\n\
+                FORMAT THE SUMMARY IN THIRD PERSON, NOT AS A DIRECT RESPONSE. Example format:\n\n\
+                ## CONVERSATION SUMMARY\n\
+                * Topic 1: Key information\n\
+                * Topic 2: Key information\n\n\
+                ## TOOLS EXECUTED\n\
+                * Tool X: Result Y\n\n\
+                ## TODO ID\n\
+                * <id>\n\n\
+                Remember this is a DOCUMENT not a chat response.\n\
+                FILTER OUT CHAT CONVENTIONS (greetings, offers to help, etc).".to_string()
+        },
+    };
+
+    if let Some(summary) = latest_summary {
+        summary_content.push_str("\n\n");
+        summary_content.push_str(CONTEXT_ENTRY_START_HEADER);
+        summary_content.push_str("This summary contains ALL relevant information from our previous conversation including tool uses, results, code analysis, and file operations. YOU MUST be sure to include this information when creating your summarization document.\n\n");
+        summary_content.push_str("SUMMARY CONTENT:\n");
+        summary_content.push_str(summary.as_ref());
+        summary_content.push('\n');
+        summary_content.push_str(CONTEXT_ENTRY_END_HEADER);
+    }
+
+    summary_content
+}

crates/agent/src/agent/compact.rs

@@ -9,5 +9,10 @@ pub const DUMMY_TOOL_NAME: &str = "dummy";
 pub const MAX_RESOURCE_FILE_LENGTH: u64 = 1024 * 10;
 
 pub const RTS_VALID_TOOL_NAME_REGEX: &str = "^[a-zA-Z][a-zA-Z0-9_-]{0,64}$";
+
 pub const MAX_TOOL_NAME_LEN: usize = 64;
+
 pub const MAX_TOOL_SPEC_DESCRIPTION_LEN: usize = 10_004;
+
+/// 10 MB
+pub const MAX_IMAGE_SIZE_BYTES: u64 = 10 * 1024 * 1024;