diff --git a/docs/en/how-to/connect_via_mcp.md b/docs/en/how-to/connect_via_mcp.md index f04d8f75eb24..cc5a35b14e78 100644 --- a/docs/en/how-to/connect_via_mcp.md +++ b/docs/en/how-to/connect_via_mcp.md @@ -175,5 +175,5 @@ testing and debugging Toolbox server. | Claude Desktop | ✅ | | | MCP Inspector | ✅ | | | Cursor | ✅ | | -| Windsurf | ✅ | | -| VS Code (Insiders) | ✅ | | +| Windsurf | ✅ | | +| VS Code (Insiders) | ✅ | | \ No newline at end of file diff --git a/docs/en/resources/tools/_index.md b/docs/en/resources/tools/_index.md index 19c7096fc68f..c5541e1a3981 100644 --- a/docs/en/resources/tools/_index.md +++ b/docs/en/resources/tools/_index.md @@ -53,9 +53,9 @@ parameters: MCP Toolbox provides two main approaches for tools: **prebuilt** and **custom**. -[**Prebuilt tools**](../../reference/prebuilt-tools/) are ready to use out of +[**Prebuilt tools**](../../reference/prebuilt-tools.md) are ready to use out of the box. For example, a tool like -[`postgres-execute-sql`](postgres/postgres-execute-sql/) has fixed parameters +[`postgres-execute-sql`](postgres/postgres-execute-sql.md) has fixed parameters and always works the same way, allowing the agent to execute arbitrary SQL. While these are convenient, they are typically only safe when a developer is in the loop (e.g., during prototyping, developing, or debugging). @@ -67,7 +67,7 @@ production is highly dangerous. To secure your application, you should **use custom tools** to suit your specific schema and application needs. Creating a custom tool restricts the agent's capabilities to only what is necessary. For example, you can use the -[`postgres-sql`](postgres/postgres-sql/) tool to define a specific action. This +[`postgres-sql`](postgres/postgres-sql.md) tool to define a specific action. This typically involves: * **Prepared Statements:** Writing a SQL query ahead of time and letting the @@ -365,4 +365,4 @@ Annotations appear in the `tools/list` MCP response: } ``` -## Kinds of tools +## Kinds of tools \ No newline at end of file diff --git a/docs/en/sdks/JS-sdk/adk/index.md b/docs/en/sdks/JS-sdk/adk/index.md index e1babd87aec4..5dd556aa75ee 100644 --- a/docs/en/sdks/JS-sdk/adk/index.md +++ b/docs/en/sdks/JS-sdk/adk/index.md @@ -28,7 +28,7 @@ npm install @toolbox-sdk/adk 1. **Start the Toolbox Service** - - Make sure the MCP Toolbox service is running. See the [Toolbox Getting Started Guide](/getting-started/introduction/#getting-started). + - Make sure the MCP Toolbox service is running. See the [Toolbox Getting Started Guide](../../../getting-started/introduction/_index.md#getting-started). 2. **Minimal Example** @@ -147,7 +147,7 @@ const result = await tool.runAsync(args: {a: 5, b: 2}) ``` {{< notice tip>}} -For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart Guide](getting-started/local_quickstart). +For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart Guide](../../../getting-started/local_quickstart.md). {{< /notice >}} ## Client to Server Authentication @@ -206,7 +206,8 @@ const client = new ToolboxClient(URL, null, {"Authorization": getGoogleIdTokenGe For Toolbox servers hosted on Google Cloud (e.g., Cloud Run) and requiring `Google ID token` authentication, the helper module -[auth_methods](src/toolbox_core/authMethods.ts) provides utility functions. +[auth_methods](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/packages/toolbox-core/src/toolbox_core/authMethods.ts) provides utility functions. + ### Step by Step Guide for Cloud Run @@ -251,14 +252,13 @@ Oauth2 tokens) when invoking that specific tool. ### Supported Authentication Mechanisms -The Toolbox service enables secure tool usage through **Authenticated Parameters**. For detailed information on how these mechanisms work within the Toolbox service and how to configure them, please refer to [Toolbox Service Documentation - Authenticated Parameters](resources/tools/#authenticated-parameters) - +The Toolbox service enables secure tool usage through **Authenticated Parameters**. For detailed information on how these mechanisms work within the Toolbox service and how to configure them, please refer to [Toolbox Service Documentation - Authenticated Parameters](../../../resources/tools/_index.md#authenticated-parameters) ### Step 1: Configure Tools in Toolbox Service First, ensure the target tool(s) are configured correctly in the Toolbox service to require authentication. Refer to the [Toolbox Service Documentation - Authenticated -Parameters](resources/tools/#authenticated-parameters) +Parameters](../../../resources/tools/_index.md#authenticated-parameters) for instructions. ### Step 2: Configure SDK Client diff --git a/docs/en/sdks/JS-sdk/core/index.md b/docs/en/sdks/JS-sdk/core/index.md index 3845b42b960f..bf46134f2a62 100644 --- a/docs/en/sdks/JS-sdk/core/index.md +++ b/docs/en/sdks/JS-sdk/core/index.md @@ -28,7 +28,7 @@ npm install @toolbox-sdk/core 1. **Start the Toolbox Service** - - Make sure the MCP Toolbox service is running. See the [Toolbox Getting Started Guide](/getting-started/introduction/#getting-started). + - Make sure the MCP Toolbox service is running. See the [Toolbox Getting Started Guide](../../../getting-started/introduction/_index.md#getting-started). 2. **Minimal Example** @@ -147,7 +147,7 @@ const result = await tool({a: 5, b: 2}) ``` {{< notice tip>}} -For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart Guide](getting-started/local_quickstart). +For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart Guide](../../../getting-started/local_quickstart.md). {{< /notice >}} ## Client to Server Authentication @@ -249,14 +249,14 @@ Oauth2 tokens) when invoking that specific tool. ### Supported Authentication Mechanisms -The Toolbox service enables secure tool usage through **Authenticated Parameters**. For detailed information on how these mechanisms work within the Toolbox service and how to configure them, please refer to [Toolbox Service Documentation - Authenticated Parameters](resources/tools/#authenticated-parameters) +The Toolbox service enables secure tool usage through **Authenticated Parameters**. For detailed information on how these mechanisms work within the Toolbox service and how to configure them, please refer to [Toolbox Service Documentation - Authenticated Parameters](../../../resources/tools/_index.md#authenticated-parameters) ### Step 1: Configure Tools in Toolbox Service First, ensure the target tool(s) are configured correctly in the Toolbox service to require authentication. Refer to the [Toolbox Service Documentation - Authenticated -Parameters](resources/tools/#authenticated-parameters) +Parameters](../../../resources/tools/_index.md#authenticated-parameters) for instructions. ### Step 2: Configure SDK Client @@ -448,9 +448,7 @@ await multiplyNumbers.invoke({ a: 2, b: 3 }); ``` The `multiplyNumbers` tool is compatible with [Langchain/Langraph -agents](http://js.langchain.com/docs/concepts/agents/) -such as [React -Agents](https://langchain-ai.github.io/langgraphjs/reference/functions/langgraph_prebuilt.createReactAgent.html). +agents](http://js.langchain.com/docs/concepts/agents/). diff --git a/docs/en/sdks/go-sdk/tbadk/_index.md b/docs/en/sdks/go-sdk/tbadk/_index.md index d477ad0110a3..b3872f8a1a34 100644 --- a/docs/en/sdks/go-sdk/tbadk/_index.md +++ b/docs/en/sdks/go-sdk/tbadk/_index.md @@ -179,7 +179,7 @@ result, err := tool.Run(ctx, inputs) {{< notice tip >}}For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart -Guide](https://googleapis.github.io/genai-toolbox/getting-started/local_quickstart). +Guide](../../../getting-started/local_quickstart.md). {{< /notice >}} ## Client to Server Authentication @@ -247,7 +247,7 @@ client, err := tbadk.NewToolboxClient( For Toolbox servers hosted on Google Cloud (e.g., Cloud Run) and requiring `Google ID token` authentication, the helper module -[auth_methods](/core/auth.go) provides utility functions. +[auth_methods](https://github.com/googleapis/mcp-toolbox-sdk-go/blob/main/core/auth.go) provides utility functions. ### Step by Step Guide for Cloud Run diff --git a/docs/en/sdks/python-sdk/core/index.md b/docs/en/sdks/python-sdk/core/index.md index c64b1bd53752..70a2ade7b452 100644 --- a/docs/en/sdks/python-sdk/core/index.md +++ b/docs/en/sdks/python-sdk/core/index.md @@ -29,7 +29,7 @@ The `ToolboxClient` (and its synchronous counterpart `ToolboxSyncClient`) intera ## Quickstart 1. **Start the Toolbox Service** - - Make sure the MCP Toolbox service is running on port `5000` of your local machine. See the [Toolbox Getting Started Guide](/getting-started/introduction/#getting-started). + - Make sure the MCP Toolbox service is running on port `5000` of your local machine. See the [Toolbox Getting Started Guide](../../../getting-started/introduction/_index.md#getting-started). 2. **Minimal Example** @@ -50,7 +50,7 @@ if __name__ == "__main__": {{< notice tip>}} -For a complete, end-to-end example including setting up the service and using an SDK, see the full tutorial: [**Toolbox Quickstart Tutorial**](https://googleapis.github.io/genai-toolbox/getting-started/local_quickstart) +For a complete, end-to-end example including setting up the service and using an SDK, see the full tutorial: [**Toolbox Quickstart Tutorial**](../../../getting-started/local_quickstart.md) {{< /notice >}} {{< notice note>}} @@ -177,7 +177,7 @@ result = await tool("foo", bar="baz") ``` {{< notice tip>}} -For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart Guide](getting-started/local_quickstart). +For a more comprehensive guide on setting up the Toolbox service itself, which you'll need running to use this SDK, please refer to the [Toolbox Quickstart Guide](../../../getting-started/local_quickstart.md). {{< /notice >}} ## Synchronous Usage @@ -381,12 +381,11 @@ Oauth2 tokens) when invoking that specific tool. ### Supported Authentication Mechanisms -The Toolbox service enables secure tool usage through **Authenticated Parameters**. For detailed information on how these mechanisms work within the Toolbox service and how to configure them, please refer to [Authenticated Parameters](resources/tools/#authenticated-parameters) - +The Toolbox service enables secure tool usage through **Authenticated Parameters**. For detailed information on how these mechanisms work within the Toolbox service and how to configure them, please refer to [Authenticated Parameters](../../../resources/tools/_index.md#authenticated-parameters) ### Step 1: Configure Tools in Toolbox Service First, ensure the target tool(s) are configured correctly in the Toolbox service -to require authentication. Refer to the [Authenticated Parameters](https://googleapis.github.io/genai-toolbox/resources/tools/#authenticated-parameters) +to require authentication. Refer to the [Authenticated Parameters](../../../resources/tools/_index.md#authenticated-parameters) for instructions. ### Step 2: Configure SDK Client @@ -544,4 +543,4 @@ async def get_dynamic_value(): # Assuming `tool` is a loaded tool instance from a ToolboxClient dynamic_bound_tool = tool.bind_param("param", get_dynamic_value) -``` +``` \ No newline at end of file diff --git a/docs/en/sdks/python-sdk/langchain/index.md b/docs/en/sdks/python-sdk/langchain/index.md index 3e29c64366dd..b2be5f870699 100644 --- a/docs/en/sdks/python-sdk/langchain/index.md +++ b/docs/en/sdks/python-sdk/langchain/index.md @@ -41,7 +41,7 @@ async with ToolboxClient("http://127.0.0.1:5000") as toolbox: message.pretty_print() ``` {{< notice tip >}} -For a complete, end-to-end example including setting up the service and using an SDK, see the full tutorial: [Toolbox Quickstart Tutorial](getting-started/local_quickstart) +For a complete, end-to-end example including setting up the service and using an SDK, see the full tutorial: [Toolbox Quickstart Tutorial](../../../getting-started/local_quickstart.md) {{< /notice >}} ## Usage diff --git a/docs/en/sdks/python-sdk/llamaindex/index.md b/docs/en/sdks/python-sdk/llamaindex/index.md index 6bb238e7c904..0e0b1af366d7 100644 --- a/docs/en/sdks/python-sdk/llamaindex/index.md +++ b/docs/en/sdks/python-sdk/llamaindex/index.md @@ -49,7 +49,7 @@ asyncio.run(run_agent()) ``` {{< notice tip >}} -For a complete, end-to-end example including setting up the service and using an SDK, see the full tutorial: [Toolbox Quickstart Tutorial](getting-started/local_quickstart) +For a complete, end-to-end example including setting up the service and using an SDK, see the full tutorial: [Toolbox Quickstart Tutorial](../../../getting-started/local_quickstart.md) {{< /notice >}} ## Usage