Skip to content

feat(tools/mysql-get-query-plan): tool impl + docs + tests#2123

Merged
Yuan325 merged 8 commits into
mainfrom
mysql-get-query-plan
Dec 19, 2025
Merged

feat(tools/mysql-get-query-plan): tool impl + docs + tests#2123
Yuan325 merged 8 commits into
mainfrom
mysql-get-query-plan

Conversation

@gRedHeadphone

Copy link
Copy Markdown
Contributor

Description

Tool mysql-get-query-plan implementation, along with tests and docs. Tool used to get information about how MySQL executes a SQL statement (EXPLAIN).

PR Checklist

  • 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 #1692

@gRedHeadphone gRedHeadphone requested review from a team December 5, 2025 06:29
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @gRedHeadphone, 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 introduces a dedicated mysql-get-query-plan tool to the genai-toolbox, significantly enhancing its capabilities for database performance analysis. By providing a structured way to retrieve and interpret MySQL's EXPLAIN output, this change empowers users to better understand and optimize their SQL queries, moving from a generic SQL execution tool to a specialized query plan retriever.

Highlights

  • New Tool Implementation: A new tool, mysql-get-query-plan, has been implemented to provide execution plans for SQL statements in MySQL databases, leveraging the EXPLAIN command.
  • Documentation: Comprehensive documentation for the mysql-get-query-plan tool has been added, detailing its purpose, compatible sources, input parameters, and usage examples.
  • Testing: Unit and integration tests have been added for the new mysql-get-query-plan tool, ensuring its correct functionality and integration within the existing framework for both MySQL and Cloud SQL for MySQL.
  • Configuration Updates: Existing prebuilt configurations for MySQL and Cloud SQL for MySQL have been updated to utilize the new dedicated mysql-get-query-plan tool, streamlining the process of obtaining query plans.
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.

@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 introduces a new tool, mysql-get-query-plan, to retrieve the execution plan for SQL statements in MySQL. The changes include the Go implementation of the tool, corresponding unit and integration tests, documentation, and updates to prebuilt configurations.

My review has identified a few issues:

  • A potential high-severity SQL injection vulnerability due to direct string formatting of user input.
  • A high-severity bug that could cause a panic when handling the sql_statement parameter.
  • A high-severity inconsistency between the tool's return type and the expectations of the integration tests.
  • Some minor issues in test naming and documentation.

Overall, the implementation is good, but the identified security and correctness issues should be addressed before merging.

Comment thread internal/tools/mysql/mysqlgetqueryplan/mysqlgetqueryplan.go
Comment thread internal/tools/mysql/mysqlgetqueryplan/mysqlgetqueryplan.go
Comment thread internal/tools/mysql/mysqlgetqueryplan/mysqlgetqueryplan.go
Comment thread internal/tools/mysql/mysqlgetqueryplan/mysqlgetqueryplan_test.go Outdated
Comment thread docs/en/resources/tools/mysql/mysql-get-query-plan.md Outdated
@github-actions

github-actions Bot commented Dec 5, 2025

Copy link
Copy Markdown
Contributor

gRedHeadphone and others added 3 commits December 5, 2025 06:52
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>
@github-actions

github-actions Bot commented Dec 5, 2025

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

@averikitsch averikitsch added the release candidate Use label to signal PR should be included in the next release. label Dec 18, 2025
@github-actions

Copy link
Copy Markdown
Contributor

@averikitsch averikitsch removed the release candidate Use label to signal PR should be included in the next release. label Dec 18, 2025
@Yuan325 Yuan325 enabled auto-merge (squash) December 19, 2025 00:40
@github-actions

Copy link
Copy Markdown
Contributor

@Yuan325 Yuan325 merged commit 0641da0 into main Dec 19, 2025
12 of 13 checks passed
@Yuan325 Yuan325 deleted the mysql-get-query-plan branch December 19, 2025 01:02
@github-actions

Copy link
Copy Markdown
Contributor

🧨 Preview deployments removed.

github-actions Bot pushed a commit to renovate-bot/googleapis-_-genai-toolbox that referenced this pull request Dec 19, 2025
…oogleapis#2123)

## Description

Tool mysql-get-query-plan implementation, along with tests and docs.
Tool used to get information about how MySQL executes a SQL statement
(EXPLAIN).

## PR Checklist

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] 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
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes googleapis#1692

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> 0641da0
Yuan325 added a commit that referenced this pull request Dec 19, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.24.0](v0.23.0...v0.24.0)
(2025-12-19)


### Features

* **sources/cloud-gemini-data-analytics:** Add the Gemini Data Analytics
(GDA) integration for DB NL2SQL conversion to Toolbox
([#2181](#2181))
([aa270b2](aa270b2))
* **source/cloudsqlmysql:** Add support for IAM authentication in Cloud
SQL MySQL source
([#2050](#2050))
([af3d3c5](af3d3c5))
* **sources/oracle:** Add Oracle OCI and Wallet support
([#1945](#1945))
([8ea39ec](8ea39ec))
* Support combining prebuilt and custom tool configurations
([#2188](#2188))
([5788605](5788605))
* **tools/mysql-get-query-plan:** Add new `mysql-get-query-plan` tool
for MySQL source
([#2123](#2123))
([0641da0](0641da0))


### Bug Fixes

* **spanner:** Move list graphs validation to runtime
([#2154](#2154))
([914b3ee](914b3ee))


---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
github-actions Bot pushed a commit that referenced this pull request Dec 19, 2025
🤖 I have created a release *beep* *boop*
---

##
[0.24.0](v0.23.0...v0.24.0)
(2025-12-19)

### Features

* **sources/cloud-gemini-data-analytics:** Add the Gemini Data Analytics
(GDA) integration for DB NL2SQL conversion to Toolbox
([#2181](#2181))
([aa270b2](aa270b2))
* **source/cloudsqlmysql:** Add support for IAM authentication in Cloud
SQL MySQL source
([#2050](#2050))
([af3d3c5](af3d3c5))
* **sources/oracle:** Add Oracle OCI and Wallet support
([#1945](#1945))
([8ea39ec](8ea39ec))
* Support combining prebuilt and custom tool configurations
([#2188](#2188))
([5788605](5788605))
* **tools/mysql-get-query-plan:** Add new `mysql-get-query-plan` tool
for MySQL source
([#2123](#2123))
([0641da0](0641da0))

### Bug Fixes

* **spanner:** Move list graphs validation to runtime
([#2154](#2154))
([914b3ee](914b3ee))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> f520b4e
github-actions Bot pushed a commit to renovate-bot/googleapis-_-genai-toolbox that referenced this pull request Dec 19, 2025
🤖 I have created a release *beep* *boop*
---

##
[0.24.0](googleapis/mcp-toolbox@v0.23.0...v0.24.0)
(2025-12-19)

### Features

* **sources/cloud-gemini-data-analytics:** Add the Gemini Data Analytics
(GDA) integration for DB NL2SQL conversion to Toolbox
([googleapis#2181](googleapis#2181))
([aa270b2](googleapis@aa270b2))
* **source/cloudsqlmysql:** Add support for IAM authentication in Cloud
SQL MySQL source
([googleapis#2050](googleapis#2050))
([af3d3c5](googleapis@af3d3c5))
* **sources/oracle:** Add Oracle OCI and Wallet support
([googleapis#1945](googleapis#1945))
([8ea39ec](googleapis@8ea39ec))
* Support combining prebuilt and custom tool configurations
([googleapis#2188](googleapis#2188))
([5788605](googleapis@5788605))
* **tools/mysql-get-query-plan:** Add new `mysql-get-query-plan` tool
for MySQL source
([googleapis#2123](googleapis#2123))
([0641da0](googleapis@0641da0))

### Bug Fixes

* **spanner:** Move list graphs validation to runtime
([googleapis#2154](googleapis#2154))
([914b3ee](googleapis@914b3ee))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> f520b4e
github-actions Bot pushed a commit to bhardwajRahul/genai-toolbox that referenced this pull request Dec 20, 2025
🤖 I have created a release *beep* *boop*
---

##
[0.24.0](googleapis/mcp-toolbox@v0.23.0...v0.24.0)
(2025-12-19)

### Features

* **sources/cloud-gemini-data-analytics:** Add the Gemini Data Analytics
(GDA) integration for DB NL2SQL conversion to Toolbox
([googleapis#2181](googleapis#2181))
([aa270b2](googleapis@aa270b2))
* **source/cloudsqlmysql:** Add support for IAM authentication in Cloud
SQL MySQL source
([googleapis#2050](googleapis#2050))
([af3d3c5](googleapis@af3d3c5))
* **sources/oracle:** Add Oracle OCI and Wallet support
([googleapis#1945](googleapis#1945))
([8ea39ec](googleapis@8ea39ec))
* Support combining prebuilt and custom tool configurations
([googleapis#2188](googleapis#2188))
([5788605](googleapis@5788605))
* **tools/mysql-get-query-plan:** Add new `mysql-get-query-plan` tool
for MySQL source
([googleapis#2123](googleapis#2123))
([0641da0](googleapis@0641da0))

### Bug Fixes

* **spanner:** Move list graphs validation to runtime
([googleapis#2154](googleapis#2154))
([914b3ee](googleapis@914b3ee))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> f520b4e
vinodhinic pushed a commit to vinodhinic/genai-toolbox that referenced this pull request Jan 14, 2026
…s#2123)

## Description

Tool mysql-get-query-plan implementation, along with tests and docs.
Tool used to get information about how MySQL executes a SQL statement
(EXPLAIN).

## PR Checklist

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] 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
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes googleapis#1692

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
vinodhinic pushed a commit to vinodhinic/genai-toolbox that referenced this pull request Jan 14, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.24.0](googleapis/mcp-toolbox@v0.23.0...v0.24.0)
(2025-12-19)


### Features

* **sources/cloud-gemini-data-analytics:** Add the Gemini Data Analytics
(GDA) integration for DB NL2SQL conversion to Toolbox
([googleapis#2181](googleapis#2181))
([aa270b2](googleapis@aa270b2))
* **source/cloudsqlmysql:** Add support for IAM authentication in Cloud
SQL MySQL source
([googleapis#2050](googleapis#2050))
([af3d3c5](googleapis@af3d3c5))
* **sources/oracle:** Add Oracle OCI and Wallet support
([googleapis#1945](googleapis#1945))
([8ea39ec](googleapis@8ea39ec))
* Support combining prebuilt and custom tool configurations
([googleapis#2188](googleapis#2188))
([5788605](googleapis@5788605))
* **tools/mysql-get-query-plan:** Add new `mysql-get-query-plan` tool
for MySQL source
([googleapis#2123](googleapis#2123))
([0641da0](googleapis@0641da0))


### Bug Fixes

* **spanner:** Move list graphs validation to runtime
([googleapis#2154](googleapis#2154))
([914b3ee](googleapis@914b3ee))


---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
NightStack15 added a commit to NightStack15/googleapis-_-genai-toolbox that referenced this pull request Mar 20, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.24.0](googleapis/mcp-toolbox@v0.23.0...v0.24.0)
(2025-12-19)


### Features

* **sources/cloud-gemini-data-analytics:** Add the Gemini Data Analytics
(GDA) integration for DB NL2SQL conversion to Toolbox
([#2181](googleapis/mcp-toolbox#2181))
([aa270b2](googleapis/mcp-toolbox@aa270b2))
* **source/cloudsqlmysql:** Add support for IAM authentication in Cloud
SQL MySQL source
([#2050](googleapis/mcp-toolbox#2050))
([af3d3c5](googleapis/mcp-toolbox@af3d3c5))
* **sources/oracle:** Add Oracle OCI and Wallet support
([#1945](googleapis/mcp-toolbox#1945))
([8ea39ec](googleapis/mcp-toolbox@8ea39ec))
* Support combining prebuilt and custom tool configurations
([#2188](googleapis/mcp-toolbox#2188))
([5788605](googleapis/mcp-toolbox@5788605))
* **tools/mysql-get-query-plan:** Add new `mysql-get-query-plan` tool
for MySQL source
([#2123](googleapis/mcp-toolbox#2123))
([0641da0](googleapis/mcp-toolbox@0641da0))


### Bug Fixes

* **spanner:** Move list graphs validation to runtime
([#2154](googleapis/mcp-toolbox#2154))
([914b3ee](googleapis/mcp-toolbox@914b3ee))


---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create custom tool kinds for MySQL

4 participants