1use crate::{AgentTool, ToolCallEventStream};
2use agent_client_protocol as acp;
3use anyhow::{anyhow, Result};
4use gpui::{App, AppContext, Entity, SharedString, Task};
5use language_model::LanguageModelToolResultContent;
6use project::Project;
7use schemars::JsonSchema;
8use serde::{Deserialize, Serialize};
9use std::fmt::Write;
10use std::{cmp, path::PathBuf, sync::Arc};
11use util::paths::PathMatcher;
12
13/// Fast file path pattern matching tool that works with any codebase size
14///
15/// - Supports glob patterns like "**/*.js" or "src/**/*.ts"
16/// - Returns matching file paths sorted alphabetically
17/// - Prefer the `grep` tool to this tool when searching for symbols unless you have specific information about paths.
18/// - Use this tool when you need to find files by name patterns
19/// - Results are paginated with 50 matches per page. Use the optional 'offset' parameter to request subsequent pages.
20#[derive(Debug, Serialize, Deserialize, JsonSchema)]
21pub struct FindPathToolInput {
22 /// The glob to match against every path in the project.
23 ///
24 /// <example>
25 /// If the project has the following root directories:
26 ///
27 /// - directory1/a/something.txt
28 /// - directory2/a/things.txt
29 /// - directory3/a/other.txt
30 ///
31 /// You can get back the first two paths by providing a glob of "*thing*.txt"
32 /// </example>
33 pub glob: String,
34
35 /// Optional starting position for paginated results (0-based).
36 /// When not provided, starts from the beginning.
37 #[serde(default)]
38 pub offset: usize,
39}
40
41#[derive(Debug, Serialize, Deserialize)]
42pub struct FindPathToolOutput {
43 offset: usize,
44 current_matches_page: Vec<PathBuf>,
45 all_matches_len: usize,
46}
47
48impl From<FindPathToolOutput> for LanguageModelToolResultContent {
49 fn from(output: FindPathToolOutput) -> Self {
50 if output.current_matches_page.is_empty() {
51 "No matches found".into()
52 } else {
53 let mut llm_output = format!("Found {} total matches.", output.all_matches_len);
54 if output.all_matches_len > RESULTS_PER_PAGE {
55 write!(
56 &mut llm_output,
57 "\nShowing results {}-{} (provide 'offset' parameter for more results):",
58 output.offset + 1,
59 output.offset + output.current_matches_page.len()
60 )
61 .unwrap();
62 }
63
64 for mat in output.current_matches_page {
65 write!(&mut llm_output, "\n{}", mat.display()).unwrap();
66 }
67
68 llm_output.into()
69 }
70 }
71}
72
73const RESULTS_PER_PAGE: usize = 50;
74
75pub struct FindPathTool {
76 project: Entity<Project>,
77}
78
79impl FindPathTool {
80 pub fn new(project: Entity<Project>) -> Self {
81 Self { project }
82 }
83}
84
85impl AgentTool for FindPathTool {
86 type Input = FindPathToolInput;
87 type Output = FindPathToolOutput;
88
89 fn name(&self) -> SharedString {
90 "find_path".into()
91 }
92
93 fn kind(&self) -> acp::ToolKind {
94 acp::ToolKind::Search
95 }
96
97 fn initial_title(&self, input: Self::Input) -> SharedString {
98 format!("Find paths matching “`{}`”", input.glob).into()
99 }
100
101 fn run(
102 self: Arc<Self>,
103 input: Self::Input,
104 event_stream: ToolCallEventStream,
105 cx: &mut App,
106 ) -> Task<Result<FindPathToolOutput>> {
107 let search_paths_task = search_paths(&input.glob, self.project.clone(), cx);
108
109 cx.background_spawn(async move {
110 let matches = search_paths_task.await?;
111 let paginated_matches: &[PathBuf] = &matches[cmp::min(input.offset, matches.len())
112 ..cmp::min(input.offset + RESULTS_PER_PAGE, matches.len())];
113
114 event_stream.send_update(acp::ToolCallUpdateFields {
115 title: Some(if paginated_matches.len() == 0 {
116 "No matches".into()
117 } else if paginated_matches.len() == 1 {
118 "1 match".into()
119 } else {
120 format!("{} matches", paginated_matches.len())
121 }),
122 content: Some(
123 paginated_matches
124 .iter()
125 .map(|path| acp::ToolCallContent::Content {
126 content: acp::ContentBlock::ResourceLink(acp::ResourceLink {
127 uri: format!("file://{}", path.display()),
128 name: path.to_string_lossy().into(),
129 annotations: None,
130 description: None,
131 mime_type: None,
132 size: None,
133 title: None,
134 }),
135 })
136 .collect(),
137 ),
138 raw_output: Some(serde_json::json!({
139 "paths": &matches,
140 })),
141 ..Default::default()
142 });
143
144 Ok(FindPathToolOutput {
145 offset: input.offset,
146 current_matches_page: paginated_matches.to_vec(),
147 all_matches_len: matches.len(),
148 })
149 })
150 }
151}
152
153fn search_paths(glob: &str, project: Entity<Project>, cx: &mut App) -> Task<Result<Vec<PathBuf>>> {
154 let path_matcher = match PathMatcher::new([
155 // Sometimes models try to search for "". In this case, return all paths in the project.
156 if glob.is_empty() { "*" } else { glob },
157 ]) {
158 Ok(matcher) => matcher,
159 Err(err) => return Task::ready(Err(anyhow!("Invalid glob: {err}"))),
160 };
161 let snapshots: Vec<_> = project
162 .read(cx)
163 .worktrees(cx)
164 .map(|worktree| worktree.read(cx).snapshot())
165 .collect();
166
167 cx.background_spawn(async move {
168 Ok(snapshots
169 .iter()
170 .flat_map(|snapshot| {
171 let root_name = PathBuf::from(snapshot.root_name());
172 snapshot
173 .entries(false, 0)
174 .map(move |entry| root_name.join(&entry.path))
175 .filter(|path| path_matcher.is_match(&path))
176 })
177 .collect())
178 })
179}
180
181#[cfg(test)]
182mod test {
183 use super::*;
184 use gpui::TestAppContext;
185 use project::{FakeFs, Project};
186 use settings::SettingsStore;
187 use util::path;
188
189 #[gpui::test]
190 async fn test_find_path_tool(cx: &mut TestAppContext) {
191 init_test(cx);
192
193 let fs = FakeFs::new(cx.executor());
194 fs.insert_tree(
195 "/root",
196 serde_json::json!({
197 "apple": {
198 "banana": {
199 "carrot": "1",
200 },
201 "bandana": {
202 "carbonara": "2",
203 },
204 "endive": "3"
205 }
206 }),
207 )
208 .await;
209 let project = Project::test(fs.clone(), [path!("/root").as_ref()], cx).await;
210
211 let matches = cx
212 .update(|cx| search_paths("root/**/car*", project.clone(), cx))
213 .await
214 .unwrap();
215 assert_eq!(
216 matches,
217 &[
218 PathBuf::from("root/apple/banana/carrot"),
219 PathBuf::from("root/apple/bandana/carbonara")
220 ]
221 );
222
223 let matches = cx
224 .update(|cx| search_paths("**/car*", project.clone(), cx))
225 .await
226 .unwrap();
227 assert_eq!(
228 matches,
229 &[
230 PathBuf::from("root/apple/banana/carrot"),
231 PathBuf::from("root/apple/bandana/carbonara")
232 ]
233 );
234 }
235
236 fn init_test(cx: &mut TestAppContext) {
237 cx.update(|cx| {
238 let settings_store = SettingsStore::test(cx);
239 cx.set_global(settings_store);
240 language::init(cx);
241 Project::init_settings(cx);
242 });
243 }
244}