Struct SearchCodebaseParams 

pub struct SearchCodebaseParams {
    pub query: String,
    pub is_regex: bool,
    pub path_glob: String,
    pub filter_mode: FilterMode,
    pub max_results: u32,
    pub context_lines: u32,
    pub known_files: Vec<String>,
    pub group_by_file: bool,
    pub exclude_glob: String,
    pub offset: u32,
}

Parameters for search_codebase.

Fields

query: String

Search pattern (literal or regex).

is_regex: bool

Treat query as regex.

path_glob: String

Limit search scope (e.g., src/**/*.ts).

filter_mode: FilterMode

Filter mode: code_only, comments_only, or all.

Uses Tree-sitter node classification to filter matches by context. Defaults to code_only (exclude comments and string literals).

max_results: u32

Maximum matches returned.

context_lines: u32

Lines of context above/below each match.

known_files: Vec<String>

File paths already in the agent’s context.

For matches in these files, only minimal metadata is returned (file, line, column, enclosing_semantic_path, version_hash). The full content and context lines are omitted to save tokens.

group_by_file: bool

Group matches by file in the response.

When true, the response includes file_groups instead of (or in addition to) the flat matches list. Each group contains all matches for one file with a single version_hash at group level.

exclude_glob: String

Glob pattern for files to exclude from search (e.g., **/*.test.*).

Applied before search — not as a post-filter — so excluded files are never read. Can be combined with path_glob include patterns.

offset: u32

Number of matches to skip before returning results (for pagination). Use with max_results to page through large result sets.

Trait Implementations

impl Debug for SearchCodebaseParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchCodebaseParams

fn default() -> SearchCodebaseParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchCodebaseParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SearchCodebaseParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.