Limit code_search to 30 results by default

Author: jahooma

backend/src/tools/definitions/tool/code-search.ts

@@ -43,5 +43,6 @@ ${getToolCallString(toolName, { pattern: 'foo\\.bar = 1\\.0' })}
 ${getToolCallString(toolName, { pattern: 'import.*foo', cwd: 'src' })}
 ${getToolCallString(toolName, { pattern: 'function.*authenticate', flags: '-i -t ts' })}
 ${getToolCallString(toolName, { pattern: 'TODO', flags: '-n --type-not test' })}
+${getToolCallString(toolName, { pattern: 'getUserData', maxResults: 10 })}
     `.trim(),
 } satisfies ToolDescription

common/src/templates/initial-agents-dir/types/tools.ts

@@ -1,5 +1,3 @@
-import type { Message } from './util-types'
-
 /**
  * Union type of all available tool names
  */
@@ -59,6 +57,8 @@ export interface CodeSearchParams {
   flags?: string
   /** Optional working directory to search within, relative to the project root. Defaults to searching the entire project. */
   cwd?: string
+  /** Maximum number of results to return. Defaults to 30. */
+  maxResults?: number
 }
 
 /**
@@ -78,11 +78,11 @@ export interface FindFilesParams {
  * Fetch up-to-date documentation for libraries and frameworks using Context7 API.
  */
 export interface ReadDocsParams {
-  /** The exact library or framework name (e.g., "Next.js", "MongoDB", "React"). Use the official name as it appears in documentation, not a search query. */
+  /** The library or framework name (e.g., "Next.js", "MongoDB", "React"). Use the official name as it appears in documentation if possible. Only public libraries available in Context7's database are supported, so small or private libraries may not be available. */
   libraryTitle: string
-  /** Optional specific topic to focus on (e.g., "routing", "hooks", "authentication") */
-  topic?: string
-  /** Optional maximum number of tokens to return. Defaults to 10000. Values less than 10000 are automatically increased to 10000. */
+  /** Specific topic to focus on (e.g., "routing", "hooks", "authentication") */
+  topic: string
+  /** Optional maximum number of tokens to return. Defaults to 20000. Values less than 10000 are automatically increased to 10000. */
   max_tokens?: number
 }
 
@@ -120,7 +120,7 @@ export interface RunTerminalCommandParams {
  * Set the conversation history to the provided messages.
  */
 export interface SetMessagesParams {
-  messages: Message[]
+  messages: any
 }
 
 /**
@@ -129,7 +129,7 @@ export interface SetMessagesParams {
 export interface SetOutputParams {}
 
 /**
- * Spawn multiple agents and send a prompt to each of them.
+ * Spawn multiple agents and send a prompt and/or parameters to each of them. These agents will run in parallel. Note that that means they will run independently. If you need to run agents sequentially, use spawn_agents with one agent at a time instead.
  */
 export interface SpawnAgentsParams {
   agents: {

common/src/tools/params/tool/code-search.ts

@@ -25,6 +25,13 @@ export const codeSearchParams = {
         .describe(
           `Optional working directory to search within, relative to the project root. Defaults to searching the entire project.`,
         ),
+      maxResults: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .default(30)
+        .describe(`Maximum number of results to return. Defaults to 30.`),
     })
     .describe(
       `Search for string patterns in the project's files. This tool uses ripgrep (rg), a fast line-oriented search tool. Use this tool only when read_files is not sufficient to find the files you need.`,

npm-app/src/__tests__/tool-handlers.test.ts

@@ -81,6 +81,7 @@ export interface TestInterface {
     const parameters = {
       pattern: 'testFunction',
       cwd: '__tests__/data',
+      maxResults: 30,
     }
 
     await handleCodeSearch(parameters, 'test-id')
@@ -91,6 +92,7 @@ export interface TestInterface {
   test('handles basic search without cwd', async () => {
     const parameters = {
       pattern: 'export',
+      maxResults: 30,
     }
 
     const result = await handleCodeSearch(parameters, 'test-id')
@@ -102,6 +104,7 @@ export interface TestInterface {
     const parameters = {
       pattern: 'UNIQUE_SEARCH_STRING_12345',
       cwd: 'src/__tests__/data',
+      maxResults: 30,
     }
 
     const result = await handleCodeSearch(parameters, 'test-id')
@@ -118,10 +121,27 @@ export interface TestInterface {
       pattern: 'findme_xyz789',
       flags: '-i',
       cwd: 'src/__tests__/data',
+      maxResults: 30,
     }
 
     const result = await handleCodeSearch(parameters, 'test-id')
 
     expect((result[0].value as any).stdout).toContain('findme_xyz789')
   })
+
+  test('limits results when maxResults is specified', async () => {
+    const parameters = {
+      pattern: 'export',
+      maxResults: 1,
+      cwd: 'src/__tests__/data',
+    }
+
+    const result = await handleCodeSearch(parameters, 'test-id')
+
+    // Should contain results limited message when there are more results than maxResults
+    const stdout = (result[0].value as any).stdout
+    if (stdout.includes('Results limited to 1 of')) {
+      expect(stdout).toContain('Results limited to 1 of')
+    }
+  })
 })

npm-app/src/tool-handlers.ts

@@ -178,6 +178,7 @@ export const handleCodeSearch: ToolHandler<'code_search'> = async (
 ) => {
   const projectPath = getProjectRoot()
   const rgPath = await getRgPath()
+  const maxResults = parameters.maxResults ?? 30
 
   return new Promise((resolve) => {
     let stdout = ''
@@ -228,18 +229,32 @@ export const handleCodeSearch: ToolHandler<'code_search'> = async (
 
     childProcess.on('close', (code) => {
       const lines = stdout.split('\n').filter((line) => line.trim())
-      const maxResults = 3
-      const previewResults = lines.slice(0, maxResults)
+      const limitedLines = lines.slice(0, maxResults)
+      const previewResults = limitedLines.slice(0, 3)
       if (previewResults.length > 0) {
         console.log(previewResults.join('\n'))
-        if (lines.length > maxResults) {
+        if (limitedLines.length > 3) {
           console.log('...')
         }
       }
-      console.log(green(`Found ${lines.length} results`))
+      console.log(
+        green(
+          `Found ${limitedLines.length} results${lines.length > maxResults ? ` (limited from ${lines.length})` : ''}`,
+        ),
+      )
+
+      // Limit results to maxResults
+      const limitedStdout = limitedLines.join('\n')
+
+      // Add truncation message if results were limited
+      const finalStdout =
+        lines.length > maxResults
+          ? limitedStdout +
+            `\n\n[Results limited to ${maxResults} of ${lines.length} total matches]`
+          : limitedStdout
 
       const truncatedStdout = truncateStringWithMessage({
-        str: stdout,
+        str: finalStdout,
         maxLength: 10000,
       })
       const truncatedStderr = truncateStringWithMessage({

sdk/src/tools/code-search.ts

@@ -10,11 +10,13 @@ export function codeSearch({
   pattern,
   flags,
   cwd,
+  maxResults = 30,
 }: {
   projectPath: string
   pattern: string
   flags?: string
   cwd?: string
+  maxResults?: number
 }): Promise<CodebuffToolOutput<'code_search'>> {
   return new Promise((resolve) => {
     let stdout = ''
@@ -55,12 +57,24 @@ export function codeSearch({
     })
 
     childProcess.on('close', (code) => {
+      // Limit results to maxResults
+      const lines = stdout.split('\n')
+      const limitedLines = lines.slice(0, maxResults)
+      const limitedStdout = limitedLines.join('\n')
+
+      // Add truncation message if results were limited
+      const finalStdout =
+        lines.length > maxResults
+          ? limitedStdout +
+            `\n\n[Results limited to ${maxResults} of ${lines.length} total matches]`
+          : limitedStdout
+
       // Truncate output to prevent memory issues
       const maxLength = 10000
       const truncatedStdout =
-        stdout.length > maxLength
-          ? stdout.substring(0, maxLength) + '\n\n[Output truncated]'
-          : stdout
+        finalStdout.length > maxLength
+          ? finalStdout.substring(0, maxLength) + '\n\n[Output truncated]'
+          : finalStdout
 
       const maxErrorLength = 1000
       const truncatedStderr =