docs: overhaul readme by averikitsch · Pull Request #2821 · googleapis/genai-toolbox

averikitsch · 2026-03-23T23:33:03Z

Description

Should include a concise description of the changes (bug or feature), it's
impact, along with a summary of the solution

PR Checklist

Thank you for opening a Pull Request! Before submitting your PR, there are a
few things you can do to make sure it goes smoothly:

Make sure you reviewed
CONTRIBUTING.md
Make sure to open an issue as a
bug/issue
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)
Make sure to add ! if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>

gemini-code-assist · 2026-03-23T23:33:16Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 refactors and expands the README.md to offer a much clearer and more detailed introduction to the MCP Toolbox for Databases. The changes aim to improve user onboarding by providing structured quick-start guides, clarifying the project's core functionalities, and enhancing the overall documentation experience for both new and existing users.

Highlights

Documentation Overhaul: The README.md has been completely restructured and expanded to provide a more comprehensive and user-friendly introduction to the MCP Toolbox for Databases.
Enhanced Project Overview: The README now clearly defines the dual purpose of the MCP Toolbox (ready-to-use server and custom tools framework) and includes an architecture diagram for better understanding.
Improved Quick Start Guides: Detailed quick-start sections have been added for both prebuilt tools (with MCP client configuration examples and supported databases) and custom tools (with examples for sources, tools, toolsets, and prompts).
New Integration and Feature Sections: Dedicated sections were introduced for integrating with the Gemini CLI, using various SDKs, testing tools with the Toolbox UI, and generating Agent Skills.
Updated Badges and Versioning: New badges for Python, JS/TS, Go, and Java SDKs have been added, and the versioning policy has been revised for clarity.

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.

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. ↩

gemini-code-assist

Code Review

This pull request provides a significant and much-needed overhaul of the README.md file. The new structure is more user-friendly, with clear quick-start guides, a feature overview, and better organization of content. This will greatly improve the onboarding experience for new users. I've found one minor issue with a broken link that should be addressed.

README.md

github-actions · 2026-03-23T23:37:45Z

Link Resolution Note

Local links and directory changes work differently on GitHub than on the docsite. You must ensure fixes pass the GitHub check and also work with hugo server.
See Link Checking and Fixing with Lychee for more details.

Summary

Status	Count
🔍 Total	95
✅ Successful	72
⏳ Timeouts	0
👻 Excluded	13
❓ Unknown	0
🚫 Errors	1
⛔ Unsupported	0

Errors per input

Errors in README.md

[404] https://googleapis.github.io/genai-toolbox/about/versioning/ | Rejected status code: 404 Not Found (configurable with "accept" option)

Full Github Actions output

github-actions · 2026-03-25T18:59:57Z

🔎 Preview at https://googleapis.github.io/genai-toolbox/previews/PR-2821/

averikitsch · 2026-03-25T19:04:59Z

/gemini review

github-actions · 2026-03-25T19:08:35Z

🔎 Preview at https://googleapis.github.io/genai-toolbox/previews/PR-2821/

gemini-code-assist

Code Review

This pull request significantly updates the project's documentation in README.md and docs/en/getting-started/introduction/_index.md. The changes include a major restructuring and expansion of content, providing a clearer overview of features, quick start guides for prebuilt and custom tools, installation instructions, integration with Gemini CLI, SDKs, UI testing, telemetry, and agent skill generation. The review comments highlight a duplicate 'Telemetry' entry in the README's Table of Contents, an inconsistent capitalization for 'kind: Toolset', a broken internal link, a typo in 'environment', and an inconsistent flag usage in a code example.

README.md

docs/en/getting-started/introduction/_index.md

docs/en/documentation/introduction/_index.md

README.md

docs/en/getting-started/introduction/_index.md

README.md

Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>

github-actions · 2026-03-26T18:35:19Z

🚀 Cloudflare Preview Ready!

🔎 View Preview: https://pr-2821.toolbox-docs-6xc.pages.dev

(Note: Subsequent pushes to this PR will automatically update the preview at this same URL)

github-actions · 2026-03-26T22:26:22Z

🔎 Preview at https://googleapis.github.io/genai-toolbox/previews/PR-2821/

github-actions · 2026-03-26T22:26:35Z

🧨 Preview deployments removed.

Cloudflare Pages environments for pr-2821 have been deleted.

github-actions · 2026-03-26T22:27:19Z

🧨 Preview deployments removed.

## Description > Should include a concise description of the changes (bug or feature), it's > impact, along with a summary of the solution ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [ ] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> a68cb22

averikitsch requested a review from a team as a code owner March 23, 2026 23:33

blunderbuss-gcf bot assigned duwenxin99 Mar 23, 2026

averikitsch assigned kurtisvg and unassigned duwenxin99 Mar 23, 2026

gemini-code-assist bot reviewed Mar 23, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

gemini-code-assist bot reviewed Mar 25, 2026

View reviewed changes

kurtisvg approved these changes Mar 25, 2026

View reviewed changes

Yuan325 reviewed Mar 25, 2026

View reviewed changes

averikitsch and others added 10 commits March 26, 2026 11:25

first

58b61e7

second

f9c4d34

skills

5dea199

docs: update readme

9a39847

udpate intro

97bb60b

fix

033f2cd

Update README.md

de84cc7

Update docs/en/getting-started/introduction/_index.md

c422f9b

Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

Apply suggestions from code review

61bbe85

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>

respond to feedback

883b32a

averikitsch force-pushed the update-readme branch from 55956a0 to 883b32a Compare March 26, 2026 18:29

Merge branch 'main' into update-readme

fbb3580

averikitsch added 3 commits March 26, 2026 12:06

Update _index.md

8cefb63

Update _index.md

61fb75c

Update README.md

52ad274

averikitsch added the release candidate Use label to signal PR should be included in the next release. label Mar 26, 2026

Merge branch 'main' into update-readme

b1a721c

Yuan325 enabled auto-merge (squash) March 26, 2026 22:20

Yuan325 merged commit a68cb22 into main Mar 26, 2026
22 of 23 checks passed

Yuan325 deleted the update-readme branch March 26, 2026 22:26

Conversation

averikitsch commented Mar 23, 2026

Description

PR Checklist

Uh oh!

gemini-code-assist bot commented Mar 23, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link Resolution Note

Summary

Errors per input

Errors in README.md

Uh oh!

github-actions bot commented Mar 25, 2026

Uh oh!

averikitsch commented Mar 25, 2026

Uh oh!

github-actions bot commented Mar 25, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Mar 23, 2026 •

edited

Loading