Skip to content

docs: document read_file 20MB file size limit#27763

Open
samidhachari wants to merge 1 commit into
google-gemini:mainfrom
samidhachari:patch-1
Open

docs: document read_file 20MB file size limit#27763
samidhachari wants to merge 1 commit into
google-gemini:mainfrom
samidhachari:patch-1

Conversation

@samidhachari

Copy link
Copy Markdown

Summary

Document the 20MB file size limit enforced by the read_file tool.

The limit is currently implemented in code but not documented, which can cause confusion when users encounter the error:

File size exceeds the 20MB limit.

Changes

  • Added documentation for the 20MB read_file size limit in docs/tools/file-system.md.
  • Included the error message returned when the limit is exceeded.

Summary

Details

Related Issues

How to Validate

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

## Summary
Document the 20MB file size limit enforced by the `read_file` tool.

The limit is currently implemented in code but not documented, which can cause confusion when users encounter the error:

`File size exceeds the 20MB limit.`

## Changes

* Added documentation for the 20MB `read_file` size limit in `docs/tools/file-system.md`.
* Included the error message returned when the limit is exceeded.
@samidhachari samidhachari requested review from a team as code owners June 9, 2026 18:04
@google-cla

google-cla Bot commented Jun 9, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation for the read_file tool to explicitly state the existing 20MB file size limit. By clarifying this constraint and providing the associated error message, the change aims to reduce user confusion when attempting to process large files.

Highlights

  • Documentation Update: Added a note to the read_file tool documentation regarding the 20MB file size limit.
  • Error Message Clarity: Included the specific error message users will encounter when attempting to read files exceeding the 20MB limit.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions github-actions Bot added the size/xs An extra small PR label Jun 9, 2026
@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

📊 PR Size: size/XS

  • Lines changed: 4
  • Additions: +4
  • Deletions: -0
  • Files changed: 1

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation in docs/tools/file-system.md to document a 20 MB file size limit for the read_file tool, including the specific error message returned when this limit is exceeded. There are no review comments, and I have no additional feedback to provide.

Note: Security Review has been skipped due to the limited scope of the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority/p1 Important and should be addressed in the near term. size/xs An extra small PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant