Skip to content

Update README.md#3029

Open
AndrewBrook-Google wants to merge 1 commit intomainfrom
AndrewBrook-Google-patch-1
Open

Update README.md#3029
AndrewBrook-Google wants to merge 1 commit intomainfrom
AndrewBrook-Google-patch-1

Conversation

@AndrewBrook-Google
Copy link
Copy Markdown
Contributor

Reverted one occurrence of "genai-toolbox" which should not be updated to "mcp-toolbox" since it's in the explanation of why we had the old name.

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>

Reverted one occurrence of "genai-toolbox" which should *not* be updated to "mcp-toolbox" since it's in the explanation of why we had the old name.
Copy link
Copy Markdown
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 updates the README.md to correct a historical repository URL reference. Feedback was provided to improve the phrasing for conciseness and to use full HTTPS URLs for better link resolution. Additionally, the reviewer pointed out that the PR title and description must be updated to comply with the repository's style guide regarding Conventional Commits and issue references.


> [!NOTE]
> This solution was originally named “Gen AI Toolbox for Databases” (github.com/googleapis/mcp-toolbox) as its initial development predated MCP, but was renamed to align with the MCP compatibility.
> This solution was originally named “Gen AI Toolbox for Databases” (github.com/googleapis/genai-toolbox) as its initial development predated MCP, but was renamed to align with the MCP compatibility.
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.

medium

The phrasing 'align with the MCP compatibility' is redundant; 'align with MCP' or 'for MCP compatibility' is more concise. Additionally, using the full URL with the https:// protocol ensures better link resolution across different markdown renderers.

Also, the PR title Update README.md does not follow the Conventional Commits format required by the repository style guide (e.g., docs: update historical repository URL in README). Please also update the issue reference placeholder Fixes #<issue_number_goes_here> in the PR description.

Suggested change
> This solution was originally named Gen AI Toolbox for Databases” (github.com/googleapis/genai-toolbox) as its initial development predated MCP, but was renamed to align with the MCP compatibility.
> This solution was originally named "Gen AI Toolbox for Databases" (https://github.com/googleapis/genai-toolbox) as its initial development predated MCP, but was renamed for MCP compatibility.
References
  1. PR titles must follow the Conventional Commits format: <type>[optional scope]: <description>. (link)

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.

2 participants