Skip to content

docs: improve readability of tools list#23700

Closed
Boulder1-kihara wants to merge 3 commits intogoogle-gemini:mainfrom
Boulder1-kihara:fix-tools-docs-formatting
Closed

docs: improve readability of tools list#23700
Boulder1-kihara wants to merge 3 commits intogoogle-gemini:mainfrom
Boulder1-kihara:fix-tools-docs-formatting

Conversation

@Boulder1-kihara
Copy link

Summary

Reformatted the tools reference documentation from a cramped table into a highly readable, categorized list.

Details

The previous table format squished tool descriptions and parameters, making them difficult to read on smaller screens or GitHub's default markdown preview. This PR extracts the tools into a structured, bulleted list grouped by their primary function category. No tool descriptions or parameters were altered or removed, only formatted.

Related Issues

Fixes #21504

How to Validate

  1. View the changed files in this PR.
  2. Ensure the markdown renders correctly as a categorized list.
  3. Verify that no tools from the original table were accidentally omitted.

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

@Boulder1-kihara Boulder1-kihara requested review from a team as code owners March 24, 2026 19:46
@gemini-code-assist
Copy link
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 significantly enhances the readability and user experience of the tools reference documentation. By transforming the previous table-based format into a structured, categorized list, it addresses issues with cramped text and poor rendering on various screen sizes, making the information more accessible and easier to digest for users.

Highlights

  • Documentation Readability: The tools reference documentation has been reformatted from a cramped table into a highly readable, categorized list, significantly improving user experience, especially on smaller screens and GitHub's markdown preview.
  • Content Preservation: No tool descriptions or parameters were altered or removed; only the presentation format was changed to enhance clarity and organization.
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 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 counter productive. 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.

Copy link
Contributor

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

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 reformats the docs/reference/tools.md file, changing the presentation of available tools from a table to a more structured list format. However, a review comment points out that this reformatting inadvertently removed the "Under the hood" section, which contained valuable information for developers on extending the Gemini CLI with custom tools. The PR description was also noted as inaccurate for not mentioning this content removal, and it is recommended to re-integrate this documentation.

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

I am having trouble creating individual review comments. Click here to see my feedback.

docs/reference/tools.md (90-96)

high

This pull request is intended to improve readability by reformatting the tools list, but it also removes the "Under the hood" section. This section contains valuable information for developers on how to extend Gemini CLI with custom tools, including mentioning the tools.discoveryCommand setting. The PR description states that only formatting was changed, which is not accurate as this content has been removed. Please consider re-integrating this information to avoid losing important documentation for developers.

@gemini-cli gemini-cli bot added area/documentation Gemini CLI documentation tasks and issues help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support! labels Mar 24, 2026
@Boulder1-kihara
Copy link
Author

Code Review

This pull request reformats the docs/reference/tools.md file, changing the presentation of available tools from a table to a more structured list format. However, a review comment points out that this reformatting inadvertently removed the "Under the hood" section, which contained valuable information for developers on extending the Gemini CLI with custom tools. The PR description was also noted as inaccurate for not mentioning this content removal, and it is recommended to re-integrate this documentation.

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

I am having trouble creating individual review comments. Click here to see my feedback.

Code Review

This pull request reformats the docs/reference/tools.md file, changing the presentation of available tools from a table to a more structured list format. However, a review comment points out that this reformatting inadvertently removed the "Under the hood" section, which contained valuable information for developers on extending the Gemini CLI with custom tools. The PR description was also noted as inaccurate for not mentioning this content removal, and it is recommended to re-integrate this documentation.

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

I am having trouble creating individual review comments. Click here to see my feedback.

Good catch! Thank you for the review. I have restored the missing 'Under the hood' section in the latest commit so no developer documentation is lost

@Boulder1-kihara
Copy link
Author

Good catch! Thank you for the review. I have restored the missing 'Under the hood' section in the latest commit so no developer documentation is lost

@Boulder1-kihara Boulder1-kihara marked this pull request as draft March 25, 2026 07:25
@Boulder1-kihara Boulder1-kihara marked this pull request as ready for review March 25, 2026 07:39
Copy link
Contributor

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

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 refactors the docs/reference/tools.md file. The primary change involves converting the 'Available tools' section from a Markdown table into a more structured and readable list format, utilizing headings and bullet points to detail each tool and its parameters. Additionally, a prettier-ignore comment was removed, and a newline was added at the end of the file. I have no feedback to provide as there were no review comments.

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

@g-samroberts
Copy link
Contributor

Hi, this issue is already fixed by a PR submitted by a contributor assigned to issue. Before creating future PRs, please make sure the issue is labeled as help-wanted and unassigned, and assign to yourself with the /assign comment. Thanks!

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

Labels

area/documentation Gemini CLI documentation tasks and issues help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: /docs/reference/tools/ tools list is hard to read

2 participants