-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: add upgrading doc for v1 release #2832
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # Upgrading to MCP Toolbox for Databases v1.0.0 | ||
|
|
||
| Welcome to the v1.0.0 release of the MCP Toolbox for Databases! | ||
|
|
||
| This release stabilizes our core APIs and standardizes our protocol alignments. | ||
| As part of this milestone, we have introduced several breaking changes and | ||
| deprecations that require updates to your configuration and code. | ||
|
|
||
| **📖 New Versioning Policy** | ||
| We have officially published our [Versioning Policy](https://googleapis.github.io/genai-toolbox/dev/about/versioning/). Moving forward, we follow standard versioning conventions to classify updates: | ||
| * **Major (vX.0.0):** Breaking changes requiring manual updates. | ||
| * **Minor (v1.X.0):** New, backward-compatible features and deprecation notices. | ||
| * **Patch (v1.0.X):** Backward-compatible bug fixes and security patches. | ||
|
|
||
| This guide outlines what has changed and the steps you need to take to upgrade. | ||
|
|
||
| ## 🚨 Breaking Changes (Action Required) | ||
|
|
||
| ### 1. Endpoint Transition: `/api` disabled by default | ||
| The legacy `/api` endpoint for the native Toolbox protocol is now disabled by default. All official SDKs have been updated to use the `/mcp` endpoint, which aligns with the standard Model Context Protocol (MCP) specification. | ||
|
|
||
| If you still require the legacy `/api` endpoint, you must explicitly activate it using a new command-line flag. | ||
|
|
||
| * **Usage:** `./toolbox --enable-api` | ||
| * **Migration:** You must update all custom implementations to use the `/mcp` | ||
| endpoint exclusively, as the `/api` endpoint is now deprecated. If your workflow | ||
| relied on a non-standard feature that is missing from the new implementation, please submit a | ||
| feature request on our [GitHub Issues page](https://github.com/googleapis/genai-toolbox/issues). | ||
| * **UI Dependency:** Until the UI is officially migrated, it still requires the API to function. You must run the toolbox with both flags: `./toolbox --ui --enable-api`. | ||
|
|
||
| ### 2. Strict Tool Naming Validation (SEP986) | ||
| Tool names are now strictly validated against [ModelContextProtocol SEP986 guidelines](https://github.com/alexhancock/modelcontextprotocol/blob/main/docs/specification/draft/server/tools.mdx#tool-names) prior to MCP initialization. | ||
| * **Migration:** Ensure all your tool names **only** contain alphanumeric characters, hyphens (`-`), underscores (`_`), and periods (`.`). Any other special characters will cause initialization to fail. | ||
|
|
||
| ### 3. Removed CLI Flags | ||
| The legacy snake_case flag `--tools_file` has been completely removed. | ||
| * **Migration:** Update your deployment scripts to use `--config` instead. | ||
|
|
||
| ### 4. Singular `kind` Values in Configuration | ||
Yuan325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| _(This step applies only if you are currently using the new flat format.)_ | ||
|
|
||
| All primitive kind fields in configuration files have been updated to use singular nouns instead of plural. For example, `kind: sources` is now `kind: source`, and `kind: tools` is now `kind: tool`. | ||
|
|
||
| * **Migration:** Update your configuration files to use the singular form for all `kind` | ||
| values. _(Note: If you transitioned to the flat format using the `./toolbox migrate` command, this step was handled automatically.)_ | ||
|
|
||
|
|
||
| ### 5. Configuration Schema: `authSources` renamed | ||
| The `authSources` field is no longer supported in configuration files. | ||
| * **Migration:** Rename all instances of `authSources` to `authService` in your | ||
| configuration files. | ||
Yuan325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 6. CloudSQL for SQL Server: `ipAddress` removed | ||
| The `ipAddress` field for the CloudSQL for SQL Server source was redundant and has been removed. | ||
| * **Migration:** Remove the `ipAddress` field from your CloudSQL for SQL Server configurations. | ||
Yuan325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## ⚠️ Deprecations & Modernization | ||
|
|
||
| ### 1. Flat Configuration Format Introduced | ||
| We have introduced a new, streamlined "flat" format for configuration files. While the older nested format is still supported for now, **all new features will only be added to the flat format.** | ||
|
|
||
| **Schema Restructuring (`kind` vs. `type`):** | ||
| Along with the flat format, the configuration schema has been reorganized. The | ||
| old `kind` field (which specified the specific primitive types, like | ||
| `alloydb-postgres`) has been renamed to `type`. The `kind` field is now strictly | ||
| used to declare the core primitive of the block (e.g., `source` or `tool`). | ||
|
|
||
| **Example of the new flat format:** | ||
|
|
||
| ```yaml | ||
| kind: source | ||
| name: my-source | ||
| type: alloydb-postgres | ||
| project: my-project | ||
| region: my-region | ||
| instance: my-instance | ||
| --- | ||
| kind: tool | ||
| name: my-simple-tool | ||
| type: postgres-execute-sql | ||
| source: my-source | ||
| description: this is a tool that executes the sql provided. | ||
| ``` | ||
|
|
||
| **Migration:** | ||
|
|
||
| You can automatically migrate your existing nested configurations to the new flat format using the CLI. Run the following command: | ||
|
|
||
| ```Bash | ||
| ./toolbox migrate --config <path-to-your-config> | ||
| ``` | ||
| _Note: You can also use the `--configs` or `--config-folder` flags with this command._ | ||
|
|
||
| ### 2. Deprecated CLI Flags | ||
| The following CLI flags are deprecated and will be removed in a future release. Please update your scripts: | ||
|
|
||
| * `--tools-file` ➡️ Use `--config` | ||
| * `--tools-files` ➡️ Use `--configs` | ||
| * `--tools-folder` ➡️ Use `--config-folder` | ||
|
|
||
| ## 💡 Other Notable Updates | ||
| * **Enhanced Error Handling:** Errors are now strictly categorized between Agent Errors (allowing the LLM to self-correct) and Client/Server Errors (which signal a hard stop). | ||
|
|
||
| * **Telemetry Updates:** The /mcp endpoint telemetry has been revised to fully comply with the [OpenTelemetry semantic conventions for MCP](https://opentelemetry.io/docs/specs/semconv/gen-ai/mcp/). | ||
|
|
||
| * **MCP Authorization Support:** The Model Context Protocol's [authorization specification](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization) is now fully supported. | ||
|
|
||
| * **Database Name Validation:** Removed the "required field" validation for the database name in CloudSQL for MySQL and generic MySQL sources. | ||
|
|
||
| * **Prebuilt Tools:** Toolsets have been resized for better performance. | ||
| ## 📚 Documentation Moved | ||
| Our official documentation has a new home! Please update your bookmarks to [mcp-toolbox.dev](http://mcp-toolbox.dev). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -304,4 +304,4 @@ func main() { | |
| } | ||
| ``` | ||
|
|
||
| ## Kinds of Auth Services | ||
| ## Types of Auth Services | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.