Skip to content

Docs: Create tools reference#19470

Merged
jkcinouye merged 14 commits intomainfrom
docs-tools-reference
Mar 4, 2026
Merged

Docs: Create tools reference#19470
jkcinouye merged 14 commits intomainfrom
docs-tools-reference

Conversation

@jkcinouye
Copy link
Contributor

@jkcinouye jkcinouye commented Feb 18, 2026

Summary

Consolidates tools pages into a single tools reference page.

Details

This page creates a consolidated list of our current tools which links out to smaller tools.

Related Issues

Fixes #19471

How to Validate

This is a docs-only change. Validate that there are no unintended changes, that the content is correct, and that it stages properly.

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

@jkcinouye jkcinouye changed the title Docs: Create tools reference (Draft) Docs: Create tools reference Feb 18, 2026
@gemini-cli
Copy link
Contributor

gemini-cli bot commented Feb 18, 2026

Hi @jkcinouye, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jkcinouye, 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 documentation for Gemini CLI's tool system by creating a dedicated and comprehensive tools reference. The changes involve consolidating and expanding existing information into a new, well-structured document, improving clarity and accessibility for users and developers alike. This refactoring ensures that all relevant details about tool functionality, categories, and extensibility are presented in a single, easy-to-navigate location.

Highlights

  • New Tools Reference Document: A comprehensive tools.md document has been added to the docs/reference directory, providing detailed information on Gemini CLI's internal tools, their categories, usage, and extensibility.
  • Documentation Restructuring: The previous tools-api.md document, which contained information about the core tools API, has been removed. Its content has been integrated and expanded into the new tools.md reference.
  • Link Updates: Existing documentation files (docs/cli/enterprise.md and docs/core/index.md) have been updated to point to the new tools reference document, ensuring all links are current.
  • Navigation Update: The docs/sidebar.json file has been modified to reflect the new location and title of the tools documentation, ensuring it is discoverable within the navigation structure.
Changelog
  • docs/cli/enterprise.md
    • Updated the link for Model-Context Protocol (MCP) servers to point to the new mcp-server.md path.
  • docs/core/index.md
    • Updated the link for 'Core tools API' to 'Core tools reference' and redirected it to the new ../reference/tools.md path.
  • docs/core/tools-api.md
    • Removed the file, as its content has been superseded and integrated into the new tools reference document.
  • docs/reference/tools.md
    • Added a new document providing a comprehensive reference for Gemini CLI tools, including internal tools, the /tools command, environment tools, agent workflow tools, internal coordination tools, and an 'Under the hood' section.
  • docs/sidebar.json
    • Updated the sidebar entry for 'Tools API' to 'Tools reference' and adjusted its slug to point to the new docs/reference/tools path.
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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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 is a great documentation refactoring, creating a new comprehensive tools.md reference page and removing the outdated tools-api.md. The new documentation is well-structured and provides a much clearer overview of the available tools. I've identified one high-severity issue where the new documentation for the /tools command incorrectly describes its functionality regarding MCP tools, which could lead to user confusion.

@github-actions
Copy link

github-actions bot commented Feb 18, 2026

Size Change: -2 B (0%)

Total Size: 25.8 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 25.3 MB -2 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 221 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 227 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 11.5 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B

compressed-size-action

@gemini-cli gemini-cli bot added area/documentation Gemini CLI documentation tasks and issues 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item. labels Feb 18, 2026
@g-samroberts
Copy link
Contributor

I think once the conflicts are resolved it will be easier for to do a final review and stage. Lot of conflicts when my sidebar update/ top level tabs change went in, sorry!

@chrstnb
Copy link
Collaborator

chrstnb commented Feb 24, 2026

Build failed: Build process failed with link errors:

22:54:58 [ERROR] ✗ Found 2 invalid links in 2 files.
22:54:58   └─ /docs/tools - invalid link
22:54:58   └─ /docs/cli/commands - invalid link to custom page
22:54:58 [ERROR] [starlight-links-validator-integration] An unhandled error occurred while running the "astro:build:done" hook
    Some invalid links point to custom pages which cannot be validated, see the `exclude` option for more informations at https://starlight-links-validator.vercel.app/configuration#exclude

Copy link
Contributor

@g-samroberts g-samroberts left a comment

Choose a reason for hiding this comment

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

LGTM

@jkcinouye jkcinouye marked this pull request as ready for review February 27, 2026 22:28
@jkcinouye jkcinouye requested review from a team as code owners February 27, 2026 22:28
@jkcinouye jkcinouye changed the title (Draft) Docs: Create tools reference Docs: Create tools reference Feb 27, 2026
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 successfully consolidates the tools documentation into a single, comprehensive reference page, with the new tools.md file being well-structured and handling redirects and link updates correctly. However, a security audit identified two high-severity vulnerabilities: the web_fetch tool is vulnerable to Server-Side Request Forgery (SSRF) due to allowing local/private network access, which could be exploited via prompt injection for data exfiltration. Additionally, the "Trusted folders" mechanism is susceptible to environment variable injection, where malicious .env files could lead to Remote Code Execution (RCE) via variables like NODE_OPTIONS. Recommendations include implementing blocklists for network addresses and environment variables. Furthermore, inconsistencies in tool parameter documentation for read_file and replace tools, and some broken links in the new reference table require attention to ensure the document's accuracy and completeness.

jkcinouye and others added 3 commits March 2, 2026 13:11
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@jkcinouye jkcinouye added this pull request to the merge queue Mar 4, 2026
Merged via the queue into main with commit 29b3aa8 Mar 4, 2026
27 checks passed
@jkcinouye jkcinouye deleted the docs-tools-reference branch March 4, 2026 20:27
struckoff pushed a commit to struckoff/gemini-cli that referenced this pull request Mar 6, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
kunal-10-cloud pushed a commit to kunal-10-cloud/gemini-cli that referenced this pull request Mar 12, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
liamhelmer pushed a commit to badal-io/gemini-cli that referenced this pull request Mar 12, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
yashodipmore pushed a commit to yashodipmore/geemi-cli that referenced this pull request Mar 21, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Uplevel tools reference page

4 participants