summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenna Inouye <[email protected]>2025-07-27 15:25:04 -0700
committerGitHub <[email protected]>2025-07-27 22:25:04 +0000
commit9ed351260cc64d955580440da866098e6e5bddfb (patch)
tree64a5338d7a37882c246ae60ed79e25dff9951978
parentab0d9df658b809abaf2b7e0ca8c6b844074b5953 (diff)
Update documentation for read_many_files. (#4874)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
-rw-r--r--docs/tools/multi-file.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/tools/multi-file.md b/docs/tools/multi-file.md
index 0cd1e19e..1bc495f6 100644
--- a/docs/tools/multi-file.md
+++ b/docs/tools/multi-file.md
@@ -11,11 +11,13 @@ Use `read_many_files` to read content from multiple files specified by paths or
`read_many_files` can be used to perform tasks such as getting an overview of a codebase, finding where specific functionality is implemented, reviewing documentation, or gathering context from multiple configuration files.
+**Note:** `read_many_files` looks for files following the provided paths or glob patterns. A directory path such as `"/docs"` will return an empty result; the tool requires a pattern such as `"/docs/*"` or `"/docs/*.md"` to identify the relevant files.
+
### Arguments
`read_many_files` takes the following arguments:
-- `paths` (list[string], required): An array of glob patterns or paths relative to the tool's target directory (e.g., `["src/**/*.ts"]`, `["README.md", "docs/", "assets/logo.png"]`).
+- `paths` (list[string], required): An array of glob patterns or paths relative to the tool's target directory (e.g., `["src/**/*.ts"]`, `["README.md", "docs/*", "assets/logo.png"]`).
- `exclude` (list[string], optional): Glob patterns for files/directories to exclude (e.g., `["**/*.log", "temp/"]`). These are added to default excludes if `useDefaultExcludes` is true.
- `include` (list[string], optional): Additional glob patterns to include. These are merged with `paths` (e.g., `["*.test.ts"]` to specifically add test files if they were broadly excluded, or `["images/*.jpg"]` to include specific image types).
- `recursive` (boolean, optional): Whether to search recursively. This is primarily controlled by `**` in glob patterns. Defaults to `true`.