Add glob & list_directory tools!

Author: jahooma

.agents/types/tools.ts

@@ -6,6 +6,8 @@ export type ToolName =
   | 'code_search'
   | 'end_turn'
   | 'find_files'
+  | 'glob'
+  | 'list_directory'
   | 'lookup_agent_info'
   | 'read_docs'
   | 'read_files'
@@ -27,6 +29,8 @@ export interface ToolParamsMap {
   code_search: CodeSearchParams
   end_turn: EndTurnParams
   find_files: FindFilesParams
+  glob: GlobParams
+  list_directory: ListDirectoryParams
   lookup_agent_info: LookupAgentInfoParams
   read_docs: ReadDocsParams
   read_files: ReadFilesParams
@@ -59,7 +63,7 @@ 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. */
+  /** Maximum number of results to return per file. Defaults to 15. There is also a global limit of 250 results across all files. */
   maxResults?: number
 }
 
@@ -76,6 +80,24 @@ export interface FindFilesParams {
   prompt: string
 }
 
+/**
+ * Search for files matching a glob pattern. Returns matching file paths sorted by modification time.
+ */
+export interface GlobParams {
+  /** Glob pattern to match files against (e.g., *.js, src/glob/*.ts, glob/test/glob/*.go). */
+  pattern: string
+  /** Optional working directory to search within, relative to project root. If not provided, searches from project root. */
+  cwd?: string
+}
+
+/**
+ * List files and directories in the specified path. Returns information about each entry including name, type, size, and modification time.
+ */
+export interface ListDirectoryParams {
+  /** Directory path to list, relative to the project root. */
+  path: string
+}
+
 /**
  * Retrieve information about an agent by ID
  */

backend/package.json

@@ -42,6 +42,7 @@
     "gpt-tokenizer": "2.8.1",
     "ignore": "5.3.2",
     "lodash": "*",
+    "micromatch": "^4.0.8",
     "openai": "^4.78.1",
     "pino": "9.4.0",
     "postgres": "3.4.4",
@@ -56,6 +57,7 @@
     "@types/cors": "^2.8.19",
     "@types/diff": "^5.0.3",
     "@types/express": "^4.17.13",
+    "@types/micromatch": "^4.0.9",
     "@types/ws": "^8.5.5"
   }
 }

backend/src/tools/definitions/list.ts

@@ -7,15 +7,17 @@ import { codeSearchTool } from './tool/code-search'
 import { createPlanTool } from './tool/create-plan'
 import { endTurnTool } from './tool/end-turn'
 import { findFilesTool } from './tool/find-files'
+import { globTool } from './tool/glob'
+import { listDirectoryTool } from './tool/list-directory'
 import { lookupAgentInfoTool } from './tool/lookup-agent-info'
 import { readDocsTool } from './tool/read-docs'
 import { readFilesTool } from './tool/read-files'
 import { runFileChangeHooksTool } from './tool/run-file-change-hooks'
 import { runTerminalCommandTool } from './tool/run-terminal-command'
 import { setMessagesTool } from './tool/set-messages'
 import { setOutputTool } from './tool/set-output'
-import { spawnAgentsTool } from './tool/spawn-agents'
 import { spawnAgentInlineTool } from './tool/spawn-agent-inline'
+import { spawnAgentsTool } from './tool/spawn-agents'
 import { strReplaceTool } from './tool/str-replace'
 import { thinkDeeplyTool } from './tool/think-deeply'
 import { updateSubgoalTool } from './tool/update-subgoal'
@@ -34,6 +36,8 @@ const toolDescriptions = {
   create_plan: createPlanTool,
   end_turn: endTurnTool,
   find_files: findFilesTool,
+  glob: globTool,
+  list_directory: listDirectoryTool,
   lookup_agent_info: lookupAgentInfoTool,
   read_docs: readDocsTool,
   read_files: readFilesTool,

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

@@ -29,7 +29,7 @@ The pattern supports regular expressions and will search recursively through all
 - Automatically ignores binary files, hidden files, and files in .gitignore
 
 
-ADVANCED RIPGREP FLAGS (use the flags parameter):
+Advanced ripgrep flags (use the flags parameter):
 
 - Case sensitivity: "-i" for case-insensitive search
 - File type filtering: "-t ts" (TypeScript), "-t js" (JavaScript), "-t py" (Python), etc.

backend/src/tools/definitions/tool/glob.ts

@@ -0,0 +1,30 @@
+import { getToolCallString } from '@codebuff/common/tools/utils'
+
+import type { ToolDescription } from '../tool-def-type'
+
+const toolName = 'glob'
+export const globTool = {
+  toolName,
+  description: `
+Example:
+${getToolCallString(toolName, {
+  pattern: '**/*.test.ts',
+})}
+
+Purpose: Search for files matching a glob pattern to discover files by name patterns rather than content.
+Use cases:
+- Find all files with a specific extension (e.g., "*.js", "*.test.ts")
+- Locate files in specific directories (e.g., "src/**/*.ts")
+- Find files with specific naming patterns (e.g., "**/test_*.go", "**/*-config.json")
+- Discover test files, configuration files, or other files with predictable naming
+
+Glob patterns support:
+- * matches any characters except /
+- ** matches any characters including /
+- ? matches a single character
+- [abc] matches one of the characters in brackets
+- {a,b} matches one of the comma-separated patterns
+
+This tool is fast and works well for discovering files by name patterns.
+      `.trim(),
+} satisfies ToolDescription

backend/src/tools/definitions/tool/list-directory.ts

@@ -0,0 +1,20 @@
+import { getToolCallString } from '@codebuff/common/tools/utils'
+
+import type { ToolDescription } from '../tool-def-type'
+
+const toolName = 'list_directory'
+export const listDirectoryTool = {
+  toolName,
+  description: `
+Lists all files and directories in the specified path. Useful for exploring directory structure and finding files.
+
+Example:
+${getToolCallString(toolName, {
+  path: 'src/components',
+})}
+
+${getToolCallString(toolName, {
+  path: '.',
+})}
+    `.trim(),
+} satisfies ToolDescription

backend/src/tools/handlers/list.ts

@@ -5,15 +5,17 @@ import { handleCodeSearch } from './tool/code-search'
 import { handleCreatePlan } from './tool/create-plan'
 import { handleEndTurn } from './tool/end-turn'
 import { handleFindFiles } from './tool/find-files'
+import { handleGlob } from './tool/glob'
+import { handleListDirectory } from './tool/list-directory'
 import { handleLookupAgentInfo } from './tool/lookup-agent-info'
 import { handleReadDocs } from './tool/read-docs'
 import { handleReadFiles } from './tool/read-files'
 import { handleRunFileChangeHooks } from './tool/run-file-change-hooks'
 import { handleRunTerminalCommand } from './tool/run-terminal-command'
 import { handleSetMessages } from './tool/set-messages'
 import { handleSetOutput } from './tool/set-output'
-import { handleSpawnAgents } from './tool/spawn-agents'
 import { handleSpawnAgentInline } from './tool/spawn-agent-inline'
+import { handleSpawnAgents } from './tool/spawn-agents'
 import { handleStrReplace } from './tool/str-replace'
 import { handleThinkDeeply } from './tool/think-deeply'
 import { handleUpdateSubgoal } from './tool/update-subgoal'
@@ -40,6 +42,8 @@ export const codebuffToolHandlers = {
   create_plan: handleCreatePlan,
   end_turn: handleEndTurn,
   find_files: handleFindFiles,
+  glob: handleGlob,
+  list_directory: handleListDirectory,
   lookup_agent_info: handleLookupAgentInfo,
   read_docs: handleReadDocs,
   read_files: handleReadFiles,

backend/src/tools/handlers/tool/glob.ts

@@ -0,0 +1,28 @@
+import type { CodebuffToolHandlerFunction } from '../handler-function-type'
+import type {
+  ClientToolCall,
+  CodebuffToolCall,
+  CodebuffToolOutput,
+} from '@codebuff/common/tools/list'
+
+type ToolName = 'glob'
+export const handleGlob = ((params: {
+  previousToolCallFinished: Promise<void>
+  toolCall: CodebuffToolCall<ToolName>
+  requestClientToolCall: (
+    toolCall: ClientToolCall<ToolName>,
+  ) => Promise<CodebuffToolOutput<ToolName>>
+}): {
+  result: Promise<CodebuffToolOutput<ToolName>>
+  state: {}
+} => {
+  const { previousToolCallFinished, toolCall, requestClientToolCall } = params
+
+  return {
+    result: (async () => {
+      await previousToolCallFinished
+      return await requestClientToolCall(toolCall)
+    })(),
+    state: {},
+  }
+}) satisfies CodebuffToolHandlerFunction<ToolName>

backend/src/tools/handlers/tool/list-directory.ts

@@ -0,0 +1,28 @@
+import type { CodebuffToolHandlerFunction } from '../handler-function-type'
+import type {
+  ClientToolCall,
+  CodebuffToolCall,
+  CodebuffToolOutput,
+} from '@codebuff/common/tools/list'
+
+type ToolName = 'list_directory'
+export const handleListDirectory = ((params: {
+  previousToolCallFinished: Promise<void>
+  toolCall: CodebuffToolCall<ToolName>
+  requestClientToolCall: (
+    toolCall: ClientToolCall<ToolName>,
+  ) => Promise<CodebuffToolOutput<ToolName>>
+}): {
+  result: Promise<CodebuffToolOutput<ToolName>>
+  state: {}
+} => {
+  const { previousToolCallFinished, toolCall, requestClientToolCall } = params
+
+  return {
+    result: (async () => {
+      await previousToolCallFinished
+      return await requestClientToolCall(toolCall)
+    })(),
+    state: {},
+  }
+}) satisfies CodebuffToolHandlerFunction<ToolName>

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

@@ -6,6 +6,8 @@ export type ToolName =
   | 'code_search'
   | 'end_turn'
   | 'find_files'
+  | 'glob'
+  | 'list_directory'
   | 'lookup_agent_info'
   | 'read_docs'
   | 'read_files'
@@ -27,6 +29,8 @@ export interface ToolParamsMap {
   code_search: CodeSearchParams
   end_turn: EndTurnParams
   find_files: FindFilesParams
+  glob: GlobParams
+  list_directory: ListDirectoryParams
   lookup_agent_info: LookupAgentInfoParams
   read_docs: ReadDocsParams
   read_files: ReadFilesParams
@@ -59,7 +63,7 @@ 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. */
+  /** Maximum number of results to return per file. Defaults to 15. There is also a global limit of 250 results across all files. */
   maxResults?: number
 }
 
@@ -76,6 +80,24 @@ export interface FindFilesParams {
   prompt: string
 }
 
+/**
+ * Search for files matching a glob pattern. Returns matching file paths sorted by modification time.
+ */
+export interface GlobParams {
+  /** Glob pattern to match files against (e.g., *.js, src/glob/*.ts, glob/test/glob/*.go). */
+  pattern: string
+  /** Optional working directory to search within, relative to project root. If not provided, searches from project root. */
+  cwd?: string
+}
+
+/**
+ * List files and directories in the specified path. Returns information about each entry including name, type, size, and modification time.
+ */
+export interface ListDirectoryParams {
+  /** Directory path to list, relative to the project root. */
+  path: string
+}
+
 /**
  * Retrieve information about an agent by ID
  */