diff --git a/crates/assistant_tools/src/code_symbols_tool.rs b/crates/assistant_tools/src/code_symbols_tool.rs index 10965eabd0..3f753ef7e8 100644 --- a/crates/assistant_tools/src/code_symbols_tool.rs +++ b/crates/assistant_tools/src/code_symbols_tool.rs @@ -156,7 +156,7 @@ impl Tool for CodeSymbolsTool { } } -async fn file_outline( +pub async fn file_outline( project: Entity, path: String, action_log: Entity, diff --git a/crates/assistant_tools/src/read_file_tool.rs b/crates/assistant_tools/src/read_file_tool.rs index b78d8d82d6..6176acdb5d 100644 --- a/crates/assistant_tools/src/read_file_tool.rs +++ b/crates/assistant_tools/src/read_file_tool.rs @@ -1,6 +1,6 @@ -use std::path::Path; use std::sync::Arc; +use crate::code_symbols_tool::file_outline; use crate::schema::json_schema_for; use anyhow::{Result, anyhow}; use assistant_tool::{ActionLog, Tool}; @@ -13,6 +13,11 @@ use serde::{Deserialize, Serialize}; use ui::IconName; use util::markdown::MarkdownString; +/// If the model requests to read a file whose size exceeds this, then +/// the tool will return an error along with the model's symbol outline, +/// and suggest trying again using line ranges from the outline. +const MAX_FILE_SIZE_TO_READ: usize = 4096; + #[derive(Debug, Serialize, Deserialize, JsonSchema)] pub struct ReadFileToolInput { /// The relative path of the file to read. @@ -26,10 +31,10 @@ pub struct ReadFileToolInput { /// - directory1 /// - directory2 /// - /// If you wanna access `file.txt` in `directory1`, you should use the path `directory1/file.txt`. - /// If you wanna access `file.txt` in `directory2`, you should use the path `directory2/file.txt`. + /// If you want to access `file.txt` in `directory1`, you should use the path `directory1/file.txt`. + /// If you want to access `file.txt` in `directory2`, you should use the path `directory2/file.txt`. /// - pub path: Arc, + pub path: String, /// Optional line number to start reading on (1-based index) #[serde(default)] @@ -66,7 +71,7 @@ impl Tool for ReadFileTool { fn ui_text(&self, input: &serde_json::Value) -> String { match serde_json::from_value::(input.clone()) { Ok(input) => { - let path = MarkdownString::inline_code(&input.path.display().to_string()); + let path = MarkdownString::inline_code(&input.path); match (input.start_line, input.end_line) { (Some(start), None) => format!("Read file {path} (from line {start})"), (Some(start), Some(end)) => format!("Read file {path} (lines {start}-{end})"), @@ -91,12 +96,10 @@ impl Tool for ReadFileTool { }; let Some(project_path) = project.read(cx).find_project_path(&input.path, cx) else { - return Task::ready(Err(anyhow!( - "Path {} not found in project", - &input.path.display() - ))); + return Task::ready(Err(anyhow!("Path {} not found in project", &input.path,))); }; + let file_path = input.path.clone(); cx.spawn(async move |cx| { let buffer = cx .update(|cx| { @@ -104,27 +107,46 @@ impl Tool for ReadFileTool { })? .await?; - let result = buffer.read_with(cx, |buffer, _cx| { - let text = buffer.text(); - if input.start_line.is_some() || input.end_line.is_some() { + // Check if specific line ranges are provided + if input.start_line.is_some() || input.end_line.is_some() { + let result = buffer.read_with(cx, |buffer, _cx| { + let text = buffer.text(); let start = input.start_line.unwrap_or(1); let lines = text.split('\n').skip(start - 1); if let Some(end) = input.end_line { - let count = end.saturating_sub(start); + let count = end.saturating_sub(start).max(1); // Ensure at least 1 line Itertools::intersperse(lines.take(count), "\n").collect() } else { Itertools::intersperse(lines, "\n").collect() } + })?; + + action_log.update(cx, |log, cx| { + log.buffer_read(buffer, cx); + })?; + + Ok(result) + } else { + // No line ranges specified, so check file size to see if it's too big. + let file_size = buffer.read_with(cx, |buffer, _cx| buffer.text().len())?; + + if file_size <= MAX_FILE_SIZE_TO_READ { + // File is small enough, so return its contents. + let result = buffer.read_with(cx, |buffer, _cx| buffer.text())?; + + action_log.update(cx, |log, cx| { + log.buffer_read(buffer, cx); + })?; + + Ok(result) } else { - text + // File is too big, so return an error with the outline + // and a suggestion to read again with line numbers. + let outline = file_outline(project, file_path, action_log, None, 0, cx).await?; + + Ok(format!("This file was too big to read all at once. Here is an outline of its symbols:\n\n{outline}\n\nUsing the line numbers in this outline, you can call this tool again while specifying the start_line and end_line fields to see the implementations of symbols in the outline.")) } - })?; - - action_log.update(cx, |log, cx| { - log.buffer_read(buffer, cx); - })?; - - anyhow::Ok(result) + } }) } } diff --git a/crates/assistant_tools/src/read_file_tool/description.md b/crates/assistant_tools/src/read_file_tool/description.md index ff023a6bb7..b14898a2c3 100644 --- a/crates/assistant_tools/src/read_file_tool/description.md +++ b/crates/assistant_tools/src/read_file_tool/description.md @@ -1 +1,6 @@ Reads the content of the given file in the project. + +If the file is too big to read all at once, and neither a start line +nor an end line was specified, then this returns an outline of the +file's symbols (with line numbers) instead of the file's contents, +so that it can be called again with line ranges.