🤖 feat: add file_search tool for pattern matching with context #501
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
Add new file_search tool to help agents find specific code sections, verify content before editing, and confirm changes after editing. ## Features - Literal string pattern matching (case-sensitive) - Configurable context lines (0-10, default: 3) - Max results limit (1-1000, default: 100) - Returns line numbers, matching content, and surrounding context - Works with both local and SSH runtimes ## Implementation **Backend (src/services/tools/file_search.ts):** - Uses runtime.normalizePath for path resolution - Validates file size and path permissions - Efficient string search with context extraction - Consistent error handling with RuntimeError **UI (src/components/tools/FileSearchToolCall.tsx):** - Displays match count in header - Shows matches with highlighted line numbers - Context lines shown with reduced opacity - Matching line highlighted with distinct background - Handles zero matches gracefully **Types (src/types/tools.ts):** - FileSearchToolArgs: file_path, pattern, context_lines?, max_results? - FileSearchToolResult: matches array with line numbers and context - FileSearchMatch: line_number, line_content, context_before, context_after **Tests (src/services/tools/file_search.test.ts):** - 10 comprehensive tests covering: - Single and multiple matches - Empty results - Max results limit - Context line boundaries - File not found errors - Directory rejection - Case sensitivity - Substring matching ## Use Cases 1. **Pre-edit verification**: Search for exact content before file_edit_replace_string 2. **Post-edit confirmation**: Verify changes landed correctly 3. **Code exploration**: Find function definitions, imports, specific patterns 4. **Error investigation**: Locate error messages, stack traces, specific values ## Benefits - Reduces "old_string not found" errors by letting agents search first - Lower cognitive load than reading entire files - Complements file_read for targeted inspection - Enables iterative refinement of edit operations _Generated with _
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add new
file_searchtool to help agents find specific code sections, verify content before editing, and confirm changes after editing.Features
Implementation
Backend
UI Component
Types
FileSearchToolArgs: file_path, pattern, context_lines?, max_results?FileSearchToolResult: matches array with line numbers and contextFileSearchMatch: line_number, line_content, context_before, context_afterTests
10 comprehensive tests covering:
Use Cases
file_edit_replace_stringBenefits
file_readfor targeted inspectionFiles Changed
src/types/tools.ts- Types for file_search toolsrc/utils/tools/toolDefinitions.ts- Tool definition and schemasrc/utils/tools/tools.ts- Tool registrationsrc/services/tools/file_search.ts- Backend implementationsrc/services/tools/file_search.test.ts- 10 unit tests (all pass)src/components/tools/FileSearchToolCall.tsx- UI componentsrc/components/Messages/ToolMessage.tsx- Component routingGenerated with
cmux