[Feat] Summary of file write with Purpose tag in fs_write tool (#279)

akashanand98 · web-flow · commit fe0db046a910 · 2025-06-24T08:55:48.000-07:00
diff --git a/crates/chat-cli/src/cli/chat/tools/execute/mod.rs b/crates/chat-cli/src/cli/chat/tools/execute/mod.rs
@@ -14,10 +14,6 @@ use crate::cli::chat::tools::{
     OutputKind,
 };
 use crate::cli::chat::util::truncate_safe;
-use crate::cli::chat::{
-    CONTINUATION_LINE,
-    PURPOSE_ARROW,
-};
 use crate::os::Os;
 
 // Platform-specific modules
@@ -130,18 +126,8 @@ impl ExecuteCommand {
         )?;
 
         // Add the summary if available
-        if let Some(summary) = &self.summary {
-            queue!(
-                output,
-                style::Print(CONTINUATION_LINE),
-                style::Print("\n"),
-                style::Print(PURPOSE_ARROW),
-                style::SetForegroundColor(Color::Blue),
-                style::Print("Purpose: "),
-                style::ResetColor,
-                style::Print(summary),
-                style::Print("\n"),
-            )?;
+        if let Some(ref summary) = self.summary {
+            super::display_purpose(Some(summary), output)?;
         }
 
         queue!(output, style::Print("\n"))?;
diff --git a/crates/chat-cli/src/cli/chat/tools/fs_write.rs b/crates/chat-cli/src/cli/chat/tools/fs_write.rs
@@ -48,21 +48,28 @@ pub enum FsWrite {
         path: String,
         file_text: Option<String>,
         new_str: Option<String>,
+        summary: Option<String>,
     },
     #[serde(rename = "str_replace")]
     StrReplace {
         path: String,
         old_str: String,
         new_str: String,
+        summary: Option<String>,
     },
     #[serde(rename = "insert")]
     Insert {
         path: String,
         insert_line: usize,
         new_str: String,
+        summary: Option<String>,
     },
     #[serde(rename = "append")]
-    Append { path: String, new_str: String },
+    Append {
+        path: String,
+        new_str: String,
+        summary: Option<String>,
+    },
 }
 
 impl FsWrite {
@@ -93,7 +100,9 @@ impl FsWrite {
                 write_to_file(os, path, file_text).await?;
                 Ok(Default::default())
             },
-            FsWrite::StrReplace { path, old_str, new_str } => {
+            FsWrite::StrReplace {
+                path, old_str, new_str, ..
+            } => {
                 let path = sanitize_path_tool_arg(os, path);
                 let file = os.fs.read_to_string(&path).await?;
                 let matches = file.match_indices(old_str).collect::<Vec<_>>();
@@ -119,6 +128,7 @@ impl FsWrite {
                 path,
                 insert_line,
                 new_str,
+                ..
             } => {
                 let path = sanitize_path_tool_arg(os, path);
                 let mut file = os.fs.read_to_string(&path).await?;
@@ -143,7 +153,7 @@ impl FsWrite {
                 write_to_file(os, &path, file).await?;
                 Ok(Default::default())
             },
-            FsWrite::Append { path, new_str } => {
+            FsWrite::Append { path, new_str, .. } => {
                 let path = sanitize_path_tool_arg(os, path);
 
                 queue!(
@@ -182,12 +192,17 @@ impl FsWrite {
                 };
                 let new = stylize_output_if_able(os, &relative_path, &file_text);
                 print_diff(output, &prev, &new, 1)?;
+
+                // Display summary as purpose if available after the diff
+                super::display_purpose(self.get_summary(), output)?;
+
                 Ok(())
             },
             FsWrite::Insert {
                 path,
                 insert_line,
                 new_str,
+                ..
             } => {
                 let path = sanitize_path_tool_arg(os, path);
                 let relative_path = format_path(cwd, &path);
@@ -206,9 +221,15 @@ impl FsWrite {
                 let old = stylize_output_if_able(os, &relative_path, &old);
                 let new = stylize_output_if_able(os, &relative_path, &new);
                 print_diff(output, &old, &new, start_line)?;
+
+                // Display summary as purpose if available after the diff
+                super::display_purpose(self.get_summary(), output)?;
+
                 Ok(())
             },
-            FsWrite::StrReplace { path, old_str, new_str } => {
+            FsWrite::StrReplace {
+                path, old_str, new_str, ..
+            } => {
                 let path = sanitize_path_tool_arg(os, path);
                 let relative_path = format_path(cwd, &path);
                 let file = os.fs.read_to_string_sync(&path)?;
@@ -220,14 +241,21 @@ impl FsWrite {
                 let new_str = stylize_output_if_able(os, &relative_path, new_str);
                 print_diff(output, &old_str, &new_str, start_line)?;
 
+                // Display summary as purpose if available after the diff
+                super::display_purpose(self.get_summary(), output)?;
+
                 Ok(())
             },
-            FsWrite::Append { path, new_str } => {
+            FsWrite::Append { path, new_str, .. } => {
                 let path = sanitize_path_tool_arg(os, path);
                 let relative_path = format_path(cwd, &path);
                 let start_line = os.fs.read_to_string_sync(&path)?.lines().count() + 1;
                 let file = stylize_output_if_able(os, &relative_path, new_str);
                 print_diff(output, &Default::default(), &file, start_line)?;
+
+                // Display summary as purpose if available after the diff
+                super::display_purpose(self.get_summary(), output)?;
+
                 Ok(())
             },
         }
@@ -246,7 +274,7 @@ impl FsWrite {
                     bail!("The provided path must exist in order to replace or insert contents into it")
                 }
             },
-            FsWrite::Append { path, new_str } => {
+            FsWrite::Append { path, new_str, .. } => {
                 if path.is_empty() {
                     bail!("Path must not be empty")
                 };
@@ -299,6 +327,16 @@ impl FsWrite {
             _ => String::new(),
         }
     }
+
+    /// Returns the summary from any variant of the FsWrite enum
+    fn get_summary(&self) -> Option<&String> {
+        match self {
+            FsWrite::Create { summary, .. } => summary.as_ref(),
+            FsWrite::StrReplace { summary, .. } => summary.as_ref(),
+            FsWrite::Insert { summary, .. } => summary.as_ref(),
+            FsWrite::Append { summary, .. } => summary.as_ref(),
+        }
+    }
 }
 
 /// Writes `content` to `path`, adding a newline if necessary.
@@ -650,6 +688,40 @@ mod tests {
         assert!(matches!(fw, FsWrite::Append { .. }));
     }
 
+    #[test]
+    fn test_fs_write_deserialize_with_summary() {
+        let path = "/my-file";
+        let file_text = "hello world";
+        let summary = "Added hello world content";
+
+        // create with summary
+        let v = serde_json::json!({
+            "path": path,
+            "command": "create",
+            "file_text": file_text,
+            "summary": summary
+        });
+        let fw = serde_json::from_value::<FsWrite>(v).unwrap();
+        assert!(matches!(fw, FsWrite::Create { .. }));
+        if let FsWrite::Create { summary: s, .. } = &fw {
+            assert_eq!(s.as_ref().unwrap(), summary);
+        }
+
+        // str_replace with summary
+        let v = serde_json::json!({
+            "path": path,
+            "command": "str_replace",
+            "old_str": "prev string",
+            "new_str": "new string",
+            "summary": summary
+        });
+        let fw = serde_json::from_value::<FsWrite>(v).unwrap();
+        assert!(matches!(fw, FsWrite::StrReplace { .. }));
+        if let FsWrite::StrReplace { summary: s, .. } = &fw {
+            assert_eq!(s.as_ref().unwrap(), summary);
+        }
+    }
+
     #[tokio::test]
     async fn test_fs_write_tool_create() {
         let os = setup_test_directory().await;
diff --git a/crates/chat-cli/src/cli/chat/tools/mod.rs b/crates/chat-cli/src/cli/chat/tools/mod.rs
@@ -17,7 +17,12 @@ use std::path::{
     PathBuf,
 };
 
-use crossterm::style::Stylize;
+use crossterm::queue;
+use crossterm::style::{
+    self,
+    Color,
+    Stylize,
+};
 use custom_tool::CustomTool;
 use execute::ExecuteCommand;
 use eyre::Result;
@@ -415,6 +420,24 @@ fn supports_truecolor(os: &Os) -> bool {
         && shell_color::get_color_support().contains(shell_color::ColorSupport::TERM24BIT)
 }
 
+/// Helper function to display a purpose if available (for execute commands)
+pub fn display_purpose(purpose: Option<&String>, updates: &mut impl Write) -> Result<()> {
+    if let Some(purpose) = purpose {
+        queue!(
+            updates,
+            style::Print(super::CONTINUATION_LINE),
+            style::Print("\n"),
+            style::Print(super::PURPOSE_ARROW),
+            style::SetForegroundColor(Color::Blue),
+            style::Print("Purpose: "),
+            style::ResetColor,
+            style::Print(purpose),
+            style::Print("\n"),
+        )?;
+    }
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {
     use std::path::MAIN_SEPARATOR;
diff --git a/crates/chat-cli/src/cli/chat/tools/tool_index.json b/crates/chat-cli/src/cli/chat/tools/tool_index.json
@@ -111,6 +111,10 @@
         "path": {
           "description": "Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.",
           "type": "string"
+        },
+        "summary": {
+          "description": "A brief explanation of what the file change does or why it's being made.",
+          "type": "string"
         }
       },
       "required": ["command", "path"]
