fix: clarify search_files tool path parameter and make it optional #6876
Conversation
- Updated tool description to clarify that path is optional and defaults to current directory - Made path parameter truly optional in implementation with "." as default - Added clearer examples showing search without path (searches entire project) - Removed confusing "required" label that contradicted the fallback behavior This addresses the issue where LLMs were confused about needing to specify a path when searching the project root, when in reality the default behavior already searches from the current directory.
dosubot
bot
added
size:M
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
| export function getSearchFilesDescription(args: ToolArgs): string { | ||
| return `## search_files | ||
| Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. | ||
| Description: Request to perform a regex search across files in a directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with surrounding context. |
There was a problem hiding this comment.
Is this intentional to use different terminology? The description says "providing context-rich results" but later mentions "surrounding context". Could we use consistent terminology throughout for clarity?
| Example: Requesting to search for all .ts files in the current directory | ||
| Examples: | ||
| 1. Search entire project for a pattern: |
There was a problem hiding this comment.
Would it be helpful to explicitly state "path defaults to current directory when omitted" in this comment to reinforce the optional nature of the parameter?
| pushToolResult(await cline.sayAndCreateMissingParamError("search_files", "path")) | ||
| return | ||
| } | ||
| // Path is now optional with a default, so we don't need to check for it |
There was a problem hiding this comment.
This comment might be redundant since the code is self-documenting with the default value on line 18. What do you think about removing it?
|
@roomote-agent I think you went to far on the changes with this one. Is the path really required? I dont think it is. Verify that it is not in fact required (defaults to project/workspace home dir). Verify if it is actually required or not and if it is not (prgomatically) then backoff ALL changes made to src/core/prompts/tools/search-files.ts and instead remove the insinuation that the path is in fact required and then exclude it from the example(s). This will be only a minor tweak to src/core/prompts/tools/search-files.ts vs what you have now. |
|
Hi @hannesrudolph, I see your feedback. Let me investigate whether the path parameter is actually required programmatically and adjust the changes accordingly. I'll verify the default behavior and make the minimal necessary changes to the prompts file as you suggested. |
hannesrudolph
added
the
Issue/PR - Triage
This PR addresses confusion in the search_files tool description that was misleading LLMs about the path parameter requirement.
Problem
Solution
Changes
src/core/prompts/tools/search-files.ts: Updated tool description with clearer wording and examplessrc/core/tools/searchFilesTool.ts: Made path parameter optional with default valueTesting
This makes the tool behavior more intuitive and reduces confusion for LLMs using the search_files tool.
Important
The
search_filestool now has an optionalpathparameter defaulting to the current directory, with updated descriptions and examples insearch-files.tsand implementation changes insearchFilesTool.ts.pathparameter insearch_filestool is now optional, defaults to current directory..pathand provide clearer examples.search-files.ts: Updated tool description, removed "required" label frompath.searchFilesTool.ts: Implemented defaultpathvalue, removed unnecessary checks forpathpresence.This description was created by
for 6ee49aa. You can customize this summary. It will automatically update as commits are pushed.