docs(search): improve search_code query description to prevent 422 errors#2402
Open
Will-hxw wants to merge 1 commit intogithub:mainfrom
Open
docs(search): improve search_code query description to prevent 422 errors#2402Will-hxw wants to merge 1 commit intogithub:mainfrom
Will-hxw wants to merge 1 commit intogithub:mainfrom
Conversation
…rors The previous description gave AI models insufficient guidance on GitHub code search syntax, leading to common mistakes like: - Using \| instead of /...|.../ for regex OR - Confusing filename: with path: qualifiers - Misunderstanding boolean operator precedence The new description explicitly documents: - Qualifiers: repo:, org:, language:, path:, path:/regex/, symbol:, content:, is: - Boolean operators: AND, OR, NOT, parentheses - Regex syntax: surround with slashes e.g. /foo|bar/ - Glob patterns in path: path:*.ts, path:/src/**/*.js Fixes github#2390
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
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.
Summary
The previous
search_codequery description gave AI models insufficient guidance on GitHub code search syntax, leading agents to make common mistakes that result in 422 errors.Changes
Updated the
queryparameter description inpkg/github/search.goto explicitly document:/foo|bar/path:*.ts,path:/src/**/*.jsProblem examples (from real agent sessions)
These queries all caused
422 ERROR_TYPE_QUERY_PARSING_FATAL:\\"foo\\|bar\\"— used \| for regex OR; correct:/foo|bar/path:docs OR path:.github— surprising precedence without parenthesesfilename:*review*.md— filename: is not valid; correct:path:*review*.mdFixes
Fixes #2390