Improve prompts for tools (#11669)

Improves the descriptions for some of the tools. I wish we had metrics
to back up changes in how the model responds to tool schema changes so
anecdotally I'm just going to say this _seems_ improved.

Release Notes:

- N/A

Cargo.lock

@@ -383,6 +383,7 @@ dependencies = [
  "editor",
  "env_logger",
  "feature_flags",
+ "file_icons",
  "fs",
  "futures 0.3.28",
  "fuzzy",
@@ -406,6 +407,7 @@ dependencies = [
  "story",
  "theme",
  "ui",
+ "unindent",
  "util",
  "workspace",
 ]

crates/assistant2/Cargo.toml

@@ -23,6 +23,7 @@ chrono.workspace = true
 collections.workspace = true
 editor.workspace = true
 feature_flags.workspace = true
+file_icons.workspace = true
 fs.workspace = true
 futures.workspace = true
 fuzzy.workspace = true
@@ -43,6 +44,7 @@ story = { workspace = true, optional = true }
 theme.workspace = true
 ui.workspace = true
 util.workspace = true
+unindent.workspace = true
 workspace.workspace = true
 
 [dev-dependencies]

crates/assistant2/src/assistant2.rs

@@ -19,6 +19,7 @@ use collections::HashMap;
 use completion_provider::*;
 use editor::Editor;
 use feature_flags::FeatureFlagAppExt as _;
+use file_icons::FileIcons;
 use fs::Fs;
 use futures::{future::join_all, StreamExt};
 use gpui::{
@@ -127,6 +128,12 @@ impl AssistantPanel {
                     semantic_index.project_index(project.clone(), cx)
                 });
 
+                // Used in tools to render file icons
+                cx.observe_global::<FileIcons>(|_, cx| {
+                    cx.notify();
+                })
+                .detach();
+
                 let mut tool_registry = ToolRegistry::new();
                 tool_registry
                     .register(ProjectIndexTool::new(project_index.clone()))

crates/assistant2/src/tools/create_buffer.rs

@@ -35,11 +35,11 @@ impl LanguageModelTool for CreateBufferTool {
     type View = CreateBufferView;
 
     fn name(&self) -> String {
-        "create_buffer".to_string()
+        "create_file".to_string()
     }
 
     fn description(&self) -> String {
-        "Create a new buffer in the current codebase".to_string()
+        "Create a new untitled file in the current codebase. Side effect: opens it in a new pane/tab for the user to edit.".to_string()
     }
 
     fn view(&self, cx: &mut WindowContext) -> View<Self::View> {
@@ -61,7 +61,7 @@ pub struct CreateBufferView {
 
 impl Render for CreateBufferView {
     fn render(&mut self, _cx: &mut ViewContext<Self>) -> impl IntoElement {
-        div().child("Opening a buffer")
+        ui::Label::new("Opening a buffer")
     }
 }
 
@@ -81,8 +81,9 @@ impl ToolOutput for CreateBufferView {
         }
     }
 
-    fn set_input(&mut self, input: Self::Input, _cx: &mut ViewContext<Self>) {
+    fn set_input(&mut self, input: Self::Input, cx: &mut ViewContext<Self>) {
         self.input = Some(input);
+        cx.notify();
     }
 
     fn execute(&mut self, cx: &mut ViewContext<Self>) -> Task<Result<()>> {

crates/assistant2/src/tools/project_index.rs

@@ -1,12 +1,19 @@
 use anyhow::Result;
 use assistant_tooling::{LanguageModelTool, ToolOutput};
 use collections::BTreeMap;
-use gpui::{prelude::*, Model, Task};
+use file_icons::FileIcons;
+use gpui::{prelude::*, AnyElement, Model, Task};
 use project::ProjectPath;
 use schemars::JsonSchema;
 use semantic_index::{ProjectIndex, Status};
 use serde::{Deserialize, Serialize};
-use std::{fmt::Write as _, ops::Range, path::Path, sync::Arc};
+use std::{
+    fmt::Write as _,
+    ops::Range,
+    path::{Path, PathBuf},
+    str::FromStr as _,
+    sync::Arc,
+};
 use ui::{prelude::*, CollapsibleContainer, Color, Icon, IconName, Label, WindowContext};
 
 const DEFAULT_SEARCH_LIMIT: usize = 20;
@@ -38,8 +45,48 @@ pub struct ProjectIndexView {
 pub struct CodebaseQuery {
     /// Semantic search query
     query: String,
-    /// Maximum number of results to return, defaults to 20
+    /// Criteria to include results
-    limit: Option<usize>,
+    includes: Option<SearchFilter>,
+    /// Criteria to exclude results
+    excludes: Option<SearchFilter>,
+}
+
+#[derive(Deserialize, JsonSchema, Clone, Default)]
+pub struct SearchFilter {
+    /// Filter by file path prefix
+    prefix_path: Option<String>,
+    /// Filter by file extension
+    extension: Option<String>,
+    // Note: we possibly can't do content filtering very easily given the project context handling
+    // the final results, so we're leaving out direct string matches for now
+}
+
+fn project_starts_with(prefix_path: Option<String>, project_path: ProjectPath) -> bool {
+    if let Some(path) = &prefix_path {
+        if let Some(path) = PathBuf::from_str(path).ok() {
+            return project_path.path.starts_with(path);
+        }
+    }
+
+    return false;
+}
+
+impl SearchFilter {
+    fn matches(&self, project_path: &ProjectPath) -> bool {
+        let path_match = project_starts_with(self.prefix_path.clone(), project_path.clone());
+
+        path_match
+            && (if let Some(extension) = &self.extension {
+                project_path
+                    .path
+                    .extension()
+                    .and_then(|ext| ext.to_str())
+                    .map(|ext| ext == extension)
+                    .unwrap_or(false)
+            } else {
+                true
+            })
+    }
 }
 
 #[derive(Serialize, Deserialize)]
@@ -59,6 +106,56 @@ impl ProjectIndexView {
         self.expanded_header = !self.expanded_header;
         cx.notify();
     }
+
+    fn render_filter_section(
+        &mut self,
+        heading: &str,
+        filter: Option<SearchFilter>,
+        cx: &mut ViewContext<Self>,
+    ) -> Option<AnyElement> {
+        let filter = match filter {
+            Some(filter) => filter,
+            None => return None,
+        };
+
+        // Any of the filter fields can be empty. We'll show nothing if they're all empty.
+        let path = filter.prefix_path.as_ref().map(|path| {
+            let icon_path = FileIcons::get_icon(Path::new(path), cx)
+                .map(SharedString::from)
+                .unwrap_or_else(|| SharedString::from("icons/file_icons/file.svg"));
+
+            h_flex()
+                .gap_1()
+                .child("Paths: ")
+                .child(Icon::from_path(icon_path))
+                .child(ui::Label::new(path.clone()).color(Color::Muted))
+        });
+
+        let extension = filter.extension.as_ref().map(|extension| {
+            let icon_path = FileIcons::get_icon(Path::new(extension), cx)
+                .map(SharedString::from)
+                .unwrap_or_else(|| SharedString::from("icons/file_icons/file.svg"));
+
+            h_flex()
+                .gap_1()
+                .child("Extensions: ")
+                .child(Icon::from_path(icon_path))
+                .child(ui::Label::new(extension.clone()).color(Color::Muted))
+        });
+
+        if path.is_none() && extension.is_none() {
+            return None;
+        }
+
+        Some(
+            v_flex()
+                .child(ui::Label::new(heading.to_string()))
+                .gap_1()
+                .children(path)
+                .children(extension)
+                .into_any_element(),
+        )
+    }
 }
 
 impl Render for ProjectIndexView {
@@ -75,19 +172,23 @@ impl Render for ProjectIndexView {
             ProjectIndexToolState::Finished { excerpts, .. } => {
                 let file_count = excerpts.len();
 
-                let header_text = format!(
+                if excerpts.is_empty() {
-                    "Read {} {}",
+                    ("No results found".to_string(), div())
-                    file_count,
+                } else {
-                    if file_count == 1 { "file" } else { "files" }
+                    let header_text = format!(
-                );
+                        "Read {} {}",
+                        file_count,
+                        if file_count == 1 { "file" } else { "files" }
+                    );
 
-                let el = v_flex().gap_2().children(excerpts.keys().map(|path| {
+                    let el = v_flex().gap_2().children(excerpts.keys().map(|path| {
-                    h_flex().gap_2().child(Icon::new(IconName::File)).child(
+                        h_flex().gap_2().child(Icon::new(IconName::File)).child(
-                        Label::new(path.path.to_string_lossy().to_string()).color(Color::Muted),
+                            Label::new(path.path.to_string_lossy().to_string()).color(Color::Muted),
-                    )
+                        )
-                }));
+                    }));
 
-                (header_text, el)
+                    (header_text, el)
+                }
             }
         };
 
@@ -114,6 +215,16 @@ impl Render for ProjectIndexView {
                                     .child(Icon::new(IconName::MagnifyingGlass))
                                     .child(Label::new(format!("`{}`", query)).color(Color::Muted)),
                             )
+                            .children(self.render_filter_section(
+                                "Includes",
+                                self.input.includes.clone(),
+                                cx,
+                            ))
+                            .children(self.render_filter_section(
+                                "Excludes",
+                                self.input.excludes.clone(),
+                                cx,
+                            ))
                             .child(content),
                     ),
             )
@@ -165,11 +276,13 @@ impl ToolOutput for ProjectIndexView {
 
         let project_index = self.project_index.read(cx);
         let index_status = project_index.status();
-        let search = project_index.search(
+
-            self.input.query.clone(),
+        // TODO: wire the filters into the search here instead of processing after.
-            self.input.limit.unwrap_or(DEFAULT_SEARCH_LIMIT),
+        // Otherwise we'll get zero results sometimes.
-            cx,
+        let search = project_index.search(self.input.query.clone(), DEFAULT_SEARCH_LIMIT, cx);
-        );
+
+        let includes = self.input.includes.clone();
+        let excludes = self.input.excludes.clone();
 
         cx.spawn(|this, mut cx| async move {
             let search_result = search.await;
@@ -182,6 +295,17 @@ impl ToolOutput for ProjectIndexView {
                                 worktree_id: search_result.worktree.read(cx).id(),
                                 path: search_result.path,
                             };
+
+                            if let Some(includes) = &includes {
+                                if !includes.matches(&project_path) {
+                                    continue;
+                                }
+                            } else if let Some(excludes) = &excludes {
+                                if excludes.matches(&project_path) {
+                                    continue;
+                                }
+                            }
+
                             excerpts
                                 .entry(project_path)
                                 .or_default()
@@ -277,11 +401,20 @@ impl LanguageModelTool for ProjectIndexTool {
     type View = ProjectIndexView;
 
     fn name(&self) -> String {
-        "query_codebase".to_string()
+        "semantic_search_codebase".to_string()
     }
 
     fn description(&self) -> String {
-        "Semantic search against the user's current codebase, returning excerpts related to the query by computing a dot product against embeddings of code chunks in the code base and an embedding of the query.".to_string()
+        unindent::unindent(
+            r#"This search tool uses a semantic index to perform search queries across your codebase, identifying and returning excerpts of text and code possibly related to the query.
+
+            Ideal for:
+            - Discovering implementations of similar logic within the project
+            - Finding usage examples of functions, classes/structures, libraries, and other code elements
+            - Developing understanding of the codebase's architecture and design
+
+            Note: The search's effectiveness is directly related to the current state of the codebase and the specificity of your query. It is recommended that you use snippets of code that are similar to the code you wish to find."#,
+        )
     }
 
     fn view(&self, cx: &mut WindowContext) -> gpui::View<Self::View> {