fix: Clearify codebase_search path parameter optional and clarify tool descriptions #6877
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…iptions - Made path parameter optional in search_files tool (defaults to workspace root) - Updated search_files description with clearer examples - Improved codebase_search description to clarify when to use path parameter - Updated test snapshots to reflect the changes This addresses confusion where LLMs were unnecessarily specifying paths when searching from project root
dosubot
bot
added
size:M
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
Collaborator
|
@roomote-agent revert all changes to src/core/prompts/tools/search-files.ts and src/core/prompts/tools/search-files.ts, that is outside the scope that this PR is intended to fix. Make sure any tests that need to be reverted are also reverted. |
hannesrudolph
changed the title
hannesrudolph
added
the
Issue/PR - Triage
Contributor
Author
|
Hi @hannesrudolph, I see your request to revert the changes to |
…ements - Reverted all changes to src/core/prompts/tools/search-files.ts - Reverted all changes to src/core/tools/searchFilesTool.ts - Updated test snapshots to reflect the reverted search_files tool - Kept the codebase_search tool description improvements as intended
dosubot
bot
added
size:S
Contributor
Author
|
Hi @hannesrudolph, I've successfully reverted all changes to ✅ Reverted files:
✅ Kept improvements:
✅ Status:
The PR now only contains the |
Simplify codebase_search tool documentation - Condensed description to eliminate repetitive explanations about user wording - Reduced from 2 examples to 1 comprehensive example showing optional path usage - Streamlined parameter descriptions to remove redundancy - Maintained all critical requirements (English queries, semantic search, path optionality) - Reduced documentation size by ~40% while preserving clarity
Collaborator
|
@ellipsis-dev review |
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 04ae395 in 32 seconds. Click for details.
- Reviewed
32lines of code in1files - Skipped
0files when reviewing. - Skipped posting
2draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. src/core/prompts/tools/codebase-search.ts:3
- Draft comment:
The updated description is now clearer and more concise. It effectively communicates that the tool performs semantic search over the entire workspace by default. Consider adding a note that any provided 'path' should be a subdirectory relative to the project root, just to ensure users don’t mistakenly provide absolute paths. - Reason this comment was not posted:
Confidence changes required:0%<= threshold70%None
2. src/core/prompts/tools/codebase-search.ts:16
- Draft comment:
The usage examples have been reordered to show the common case first, which is an improvement. The example now clearly demonstrates how to specify a subdirectory (e.g., 'src/auth') when needed. - Reason this comment was not posted:
Confidence changes required:0%<= threshold70%None
Workflow ID: wflow_VNTx8oT47OYbrdT9
You can customize 
- Added ToolArgs import and parameter to getCodebaseSearchDescription function
- Updated path parameter description to include '(relative to the current workspace directory ${args.cwd})'
- Updated index.ts to pass args to getCodebaseSearchDescription
- Maintains consistency with other tool descriptions like list_files and search_files
Collaborator
|
https://github.com/ellipsis review |
hannesrudolph
moved this from PR [Needs Prelim Review]
to PR [Needs Review]
in Roo Code Roadmap
hannesrudolph
added
PR - Needs Review
and removed
Issue/PR - Triage
mrubens
approved these changes
Aug 9, 2025
github-project-automation
bot
moved this from PR [Needs Review]
to Done
in Roo Code Roadmap
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updates the
codebase_searchtool description to prevent LLMs from unnecessarily specifying path parameters when searching from project root.Changes
Impact
Reduces unnecessary path specifications when LLMs use the codebase_search tool, improving semantic search effectiveness.
Important
Clarified
codebase_searchtool description to emphasize default workspace search and optional path parameter.getCodebaseSearchDescription()incodebase-search.tsto clarify that the tool searches the entire workspace by default.pathparameter is optional and should only be used to limit the search scope.toolDescriptionMapinindex.tsto passargstogetCodebaseSearchDescription().This description was created by
for 414e615. You can customize this summary. It will automatically update as commits are pushed.