You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: UPGRADING.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,12 +16,17 @@ This guide outlines what has changed and the steps you need to take to upgrade.
16
16
17
17
## 🚨 Breaking Changes (Action Required)
18
18
19
-
### 1. Endpoint Standardization: `/api` removed
20
-
The legacy `/api` endpoint for the native Toolbox protocol has been completely removed. All official SDKs have been updated to use the `/mcp` endpoint, which now aligns with the standard Model Context Protocol (MCP) specification.
19
+
### 1. Endpoint Transition: `/api` disabled by default
20
+
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.
21
+
22
+
If you still require the legacy `/api` endpoint, you must explicitly activate it using a new command-line flag.
23
+
24
+
***Usage:**`./toolbox --enable-api`
21
25
***Migration:** You must update all custom implementations to use the `/mcp`
22
-
endpoint exclusively. We want to ensure no functionality is lost in this transition. If your workflow
26
+
endpoint exclusively, as the `/api` endpoint is now deprecated. If your workflow
23
27
relied on a non-standard feature that is missing from the new implementation, please submit a
24
28
feature request on our [GitHub Issues page](https://github.com/googleapis/genai-toolbox/issues).
29
+
***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`.
25
30
26
31
### 2. Strict Tool Naming Validation (SEP986)
27
32
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.
@@ -32,10 +37,12 @@ The legacy snake_case flag `--tools_file` has been completely removed.
32
37
***Migration:** Update your deployment scripts to use `--config` instead.
33
38
34
39
### 4. Singular `kind` Values in Configuration
40
+
_(This step applies only if you are currently using the new flat format.)_
41
+
35
42
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`.
36
43
37
44
***Migration:** Update your configuration files to use the singular form for all `kind`
38
-
values. _(Note: If you are using the ./toolbox migrate command to transition to the new flat format, this conversion is handled automatically)._
45
+
values. _(Note: If you transitioned to the flat format using the `./toolbox migrate` command, this step was handled automatically.)_
0 commit comments