mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-02 11:15:11 -05:00
Compare commits
7 Commits
docs-js-sd
...
docs-py-sd
| Author | SHA1 | Date | |
|---|---|---|---|
|
f5d8be166f | ||
|
|
2a68f8a36b | ||
|
|
f0c7eb129b | ||
|
|
fef07c71a1 | ||
|
|
9a232461b7 | ||
|
|
12b25a0beb | ||
|
|
073c8b3268 |
@@ -1,11 +1,12 @@
|
||||
---
|
||||
title: "Javascript"
|
||||
title: "JS SDK"
|
||||
type: docs
|
||||
weight: 7
|
||||
description: >
|
||||
Javascript SDKs to connect to the MCP Toolbox server.
|
||||
JS SDKs to connect to the MCP Toolbox server.
|
||||
---
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
The MCP Toolbox service provides a centralized way to manage and expose tools
|
||||
@@ -21,48 +22,4 @@ These JS SDKs act as clients for that service. They handle the communication nee
|
||||
By using these SDKs, you can easily leverage your Toolbox-managed tools directly
|
||||
within your JS applications or AI orchestration frameworks.
|
||||
|
||||
## Which Package Should I Use?
|
||||
|
||||
Choosing the right package depends on how you are building your application:
|
||||
|
||||
- [`@toolbox-sdk/core`](https://github.com/googleapis/mcp-toolbox-sdk-js/tree/main/packages/toolbox-core):
|
||||
This is a framework agnostic way to connect the tools to popular frameworks
|
||||
like Langchain, LlamaIndex and Genkit.
|
||||
- [`@toolbox-sdk/adk`](https://github.com/googleapis/mcp-toolbox-sdk-js/tree/main/packages/toolbox-adk):
|
||||
This package provides a seamless way to connect to [Google ADK TS](https://github.com/google/adk-js).
|
||||
|
||||
## Available Packages
|
||||
|
||||
This repository hosts the following TS packages. See the package-specific
|
||||
README for detailed installation and usage instructions:
|
||||
|
||||
| Package | Target Use Case | Integration | Path | Details (README) | Npm Version |
|
||||
| :------ | :---------- | :---------- | :---------------------- | :---------- | :---------
|
||||
| `toolbox-core` | Framework-agnostic / Custom applications | Use directly / Custom | `packages/toolbox-core/` | 📄 [View README](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/packages/toolbox-core/README.md) |  |
|
||||
| `toolbox-adk` | ADK applications | ADK | `packages/toolbox-adk/` | 📄 [View README](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/packages/toolbox-adk/README.md) |  |
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started using Toolbox tools with an application, follow these general steps:
|
||||
|
||||
1. **Set up and Run the Toolbox Service:**
|
||||
|
||||
Before using the SDKs, you need the main MCP Toolbox service running. Follow
|
||||
the instructions here: [**Toolbox Getting Started
|
||||
Guide**](https://github.com/googleapis/genai-toolbox?tab=readme-ov-file#getting-started)
|
||||
|
||||
2. **Install the Appropriate SDK:**
|
||||
|
||||
Choose the package based on your needs (see "[Which Package Should I Use?](#which-package-should-i-use)" above) and install it:
|
||||
|
||||
```bash
|
||||
# For the core, framework-agnostic SDK
|
||||
npm install @toolbox-sdk/core
|
||||
```
|
||||
|
||||
|
||||
|
||||
{{< notice note >}}
|
||||
Source code for [js-sdk](https://github.com/googleapis/mcp-toolbox-sdk-js)
|
||||
{{< /notice >}}
|
||||
[Github](https://github.com/googleapis/mcp-toolbox-sdk-js)
|
||||
@@ -1,472 +0,0 @@
|
||||
---
|
||||
title: "adk"
|
||||
type: docs
|
||||
weight: 8
|
||||
description: >
|
||||
Toolbox-adk SDK for connecting to the MCP Toolbox server and invoking tools programmatically.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The `@toolbox-sdk/adk` package provides a Javascript interface to the MCP Toolbox service, enabling you to load and invoke tools from your own applications.
|
||||
|
||||
## Supported Environments
|
||||
|
||||
This SDK is a standard Node.js package built with TypeScript, ensuring broad compatibility with the modern JavaScript ecosystem.
|
||||
|
||||
- Node.js: Actively supported on Node.js v18.x and higher. The package is compatible with both modern ES Module (import) and legacy CommonJS (require).
|
||||
- TypeScript: The SDK is written in TypeScript and ships with its own type declarations, providing a first-class development experience with autocompletion and type-checking out of the box.
|
||||
- JavaScript: Fully supports modern JavaScript in Node.js environments.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @toolbox-sdk/adk
|
||||
```
|
||||
|
||||
## Quickstart
|
||||
|
||||
|
||||
1. **Start the Toolbox Service**
|
||||
- Make sure the MCP Toolbox service is running. See the [Toolbox Getting Started Guide](/getting-started/introduction/#getting-started).
|
||||
|
||||
2. **Minimal Example**
|
||||
|
||||
Here's a minimal example to get you started. Ensure your Toolbox service is running and accessible.
|
||||
|
||||
```javascript
|
||||
|
||||
import { ToolboxClient } from '@toolbox-sdk/adk';
|
||||
const client = new ToolboxClient(URL);
|
||||
|
||||
async function quickstart() {
|
||||
try {
|
||||
const tools = await client.loadToolset();
|
||||
// Use tools
|
||||
} catch (error) {
|
||||
console.error("unable to load toolset:", error.message);
|
||||
}
|
||||
}
|
||||
quickstart();
|
||||
```
|
||||
|
||||
{{< notice note>}}
|
||||
This guide uses modern ES Module (`import`) syntax. If your project uses CommonJS, you can import the library using require: `const { ToolboxClient } = require('@toolbox-sdk/adk')`;.
|
||||
{{< /notice >}}
|
||||
|
||||
## Usage
|
||||
|
||||
Import and initialize a Toolbox client, pointing it to the URL of your running Toolbox service.
|
||||
|
||||
```javascript
|
||||
import { ToolboxClient } from '@toolbox-sdk/adk';
|
||||
|
||||
// Replace with the actual URL where your Toolbox service is running
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
|
||||
let client = new ToolboxClient(URL);
|
||||
const tools = await client.loadToolset();
|
||||
|
||||
// Use the client and tools as per requirement
|
||||
```
|
||||
|
||||
All interactions for loading and invoking tools happen through this client.
|
||||
|
||||
{{< notice note>}}
|
||||
Closing the `ToolboxClient` also closes the underlying network session shared by all tools loaded from that client. As a result, any tool instances you have loaded will cease to function and will raise an error if you attempt to invoke them after the client is closed.
|
||||
{{< /notice >}}
|
||||
|
||||
{{< notice note>}}
|
||||
For advanced use cases, you can provide an external `AxiosInstance` during initialization (e.g., `ToolboxClient(url, my_session)`).
|
||||
{{< /notice >}}
|
||||
|
||||
## Transport Protocols
|
||||
|
||||
The SDK supports multiple transport protocols to communicate with the Toolbox server. You can specify the protocol version during client initialization.
|
||||
|
||||
### Available Protocols
|
||||
|
||||
- `Protocol.MCP`: The default protocol version (currently aliases to `MCP_v20250618`).
|
||||
- `Protocol.MCP_v20241105`: Use this for compatibility with older MCP servers (November 2024 version).
|
||||
- `Protocol.MCP_v20250326`: March 2025 version.
|
||||
- `Protocol.MCP_v20250618`: June 2025 version.
|
||||
- `Protocol.MCP_v20251125`: November 2025 version.
|
||||
- `Protocol.TOOLBOX`: Legacy Toolbox protocol.
|
||||
|
||||
### Specifying a Protocol
|
||||
|
||||
You can explicitly set the protocol by passing the `protocol` argument to the `ToolboxClient` constructor.
|
||||
|
||||
```javascript
|
||||
import { ToolboxClient, Protocol } from '@toolbox-sdk/adk';
|
||||
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
|
||||
// Initialize with a specific protocol version
|
||||
const client = new ToolboxClient(URL, null, null, Protocol.MCP_v20241105);
|
||||
|
||||
const tools = await client.loadToolset();
|
||||
```
|
||||
|
||||
## Loading Tools
|
||||
|
||||
You can load tools individually or in groups (toolsets) as defined in your Toolbox service configuration. Loading a toolset is convenient when working with multiple related functions, while loading a single tool offers more granular control.
|
||||
|
||||
### Load a toolset
|
||||
|
||||
A toolset is a collection of related tools. You can load all tools in a toolset or a specific one:
|
||||
|
||||
```javascript
|
||||
// Load all tools
|
||||
const tools = await toolbox.loadToolset()
|
||||
|
||||
// Load a specific toolset
|
||||
const tools = await toolbox.loadToolset("my-toolset")
|
||||
```
|
||||
|
||||
### Load a single tool
|
||||
|
||||
Loads a specific tool by its unique name. This provides fine-grained control.
|
||||
|
||||
```javascript
|
||||
const tool = await toolbox.loadTool("my-tool")
|
||||
```
|
||||
|
||||
## Invoking Tools
|
||||
|
||||
Once loaded, tools behave like awaitable JS functions. You invoke them using `await` and pass arguments corresponding to the parameters defined in the tool's configuration within the Toolbox service.
|
||||
|
||||
```javascript
|
||||
const tool = await toolbox.loadTool("my-tool")
|
||||
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).
|
||||
{{< /notice >}}
|
||||
|
||||
## Client to Server Authentication
|
||||
|
||||
This section describes how to authenticate the ToolboxClient itself when
|
||||
connecting to a Toolbox server instance that requires authentication. This is
|
||||
crucial for securing your Toolbox server endpoint, especially when deployed on
|
||||
platforms like Cloud Run, GKE, or any environment where unauthenticated access is restricted.
|
||||
|
||||
This client-to-server authentication ensures that the Toolbox server can verify
|
||||
the identity of the client making the request before any tool is loaded or
|
||||
called. It is different from [Authenticating Tools](#authenticating-tools),
|
||||
which deals with providing credentials for specific tools within an already
|
||||
connected Toolbox session.
|
||||
|
||||
### When is Client-to-Server Authentication Needed?
|
||||
|
||||
You'll need this type of authentication if your Toolbox server is configured to
|
||||
deny unauthenticated requests. For example:
|
||||
|
||||
- Your Toolbox server is deployed on Cloud Run and configured to "Require authentication."
|
||||
- Your server is behind an Identity-Aware Proxy (IAP) or a similar
|
||||
authentication layer.
|
||||
- You have custom authentication middleware on your self-hosted Toolbox server.
|
||||
|
||||
Without proper client authentication in these scenarios, attempts to connect or
|
||||
make calls (like `load_tool`) will likely fail with `Unauthorized` errors.
|
||||
|
||||
### How it works
|
||||
|
||||
The `ToolboxClient` allows you to specify functions that dynamically generate
|
||||
HTTP headers for every request sent to the Toolbox server. The most common use
|
||||
case is to add an [Authorization
|
||||
header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Authorization)
|
||||
with a bearer token (e.g., a Google ID token).
|
||||
|
||||
These header-generating functions are called just before each request, ensuring
|
||||
that fresh credentials or header values can be used.
|
||||
|
||||
### Configuration
|
||||
|
||||
You can configure these dynamic headers as seen below:
|
||||
|
||||
```javascript
|
||||
import { ToolboxClient } from '@toolbox-sdk/adk';
|
||||
import {getGoogleIdToken} from '@toolbox-sdk/core/auth'
|
||||
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
const getGoogleIdTokenGetter = () => getGoogleIdToken(URL);
|
||||
const client = new ToolboxClient(URL, null, {"Authorization": getGoogleIdTokenGetter});
|
||||
|
||||
// Use the client as usual
|
||||
```
|
||||
|
||||
### Authenticating with Google Cloud Servers
|
||||
|
||||
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.
|
||||
|
||||
### Step by Step Guide for Cloud Run
|
||||
|
||||
1. **Configure Permissions**: [Grant](https://cloud.google.com/run/docs/securing/managing-access#service-add-principals) the `roles/run.invoker` IAM role on the Cloud
|
||||
Run service to the principal. This could be your `user account email` or a
|
||||
`service account`.
|
||||
2. **Configure Credentials**
|
||||
- Local Development: Set up
|
||||
[ADC](https://cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).
|
||||
- Google Cloud Environments: When running within Google Cloud (e.g., Compute
|
||||
Engine, GKE, another Cloud Run service, Cloud Functions), ADC is typically
|
||||
configured automatically, using the environment's default service account.
|
||||
3. **Connect to the Toolbox Server**
|
||||
|
||||
```javascript
|
||||
import { ToolboxClient } from '@toolbox-sdk/adk';
|
||||
import {getGoogleIdToken} from '@toolbox-sdk/core/auth'
|
||||
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
const getGoogleIdTokenGetter = () => getGoogleIdToken(URL);
|
||||
const client = new ToolboxClient(URL, null, {"Authorization": getGoogleIdTokenGetter});
|
||||
|
||||
// Use the client as usual
|
||||
```
|
||||
|
||||
## Authenticating Tools
|
||||
|
||||
{{< notice note>}}
|
||||
**Always use HTTPS** to connect your application with the Toolbox service, especially in **production environments** or whenever the communication involves **sensitive data** (including scenarios where tools require authentication tokens). Using plain HTTP lacks encryption and exposes your application and data to significant security risks, such as eavesdropping and tampering.
|
||||
{{< /notice >}}
|
||||
|
||||
Tools can be configured within the Toolbox service to require authentication,
|
||||
ensuring only authorized users or applications can invoke them, especially when
|
||||
accessing sensitive data.
|
||||
|
||||
### When is Authentication Needed?
|
||||
|
||||
Authentication is configured per-tool within the Toolbox service itself. If a
|
||||
tool you intend to use is marked as requiring authentication in the service, you
|
||||
must configure the SDK client to provide the necessary credentials (currently
|
||||
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)
|
||||
|
||||
### 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)
|
||||
for instructions.
|
||||
|
||||
### Step 2: Configure SDK Client
|
||||
|
||||
Your application needs a way to obtain the required Oauth2 token for the
|
||||
authenticated user. The SDK requires you to provide a function capable of
|
||||
retrieving this token *when the tool is invoked*.
|
||||
|
||||
#### Provide an ID Token Retriever Function
|
||||
|
||||
You must provide the SDK with a function (sync or async) that returns the
|
||||
necessary token when called. The implementation depends on your application's
|
||||
authentication flow (e.g., retrieving a stored token, initiating an OAuth flow).
|
||||
|
||||
{{< notice note>}}
|
||||
The name used when registering the getter function with the SDK (e.g., `"my_api_token"`) must exactly match the `name` of the corresponding `authServices` defined in the tool's configuration within the Toolbox service.
|
||||
{{< /notice >}}
|
||||
|
||||
```javascript
|
||||
|
||||
async function getAuthToken() {
|
||||
// ... Logic to retrieve ID token (e.g., from local storage, OAuth flow)
|
||||
// This example just returns a placeholder. Replace with your actual token retrieval.
|
||||
return "YOUR_ID_TOKEN" // Placeholder
|
||||
}
|
||||
```
|
||||
{{< notice tip>}}
|
||||
Your token retriever function is invoked every time an authenticated parameter requires a token for a tool call. Consider implementing caching logic within this function to avoid redundant token fetching or generation, especially for tokens with longer validity periods or if the retrieval process is resource-intensive.
|
||||
{{< /notice >}}
|
||||
|
||||
#### Option A: Add Authentication to a Loaded Tool
|
||||
|
||||
You can add the token retriever function to a tool object *after* it has been
|
||||
loaded. This modifies the specific tool instance.
|
||||
|
||||
```javascript
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
let client = new ToolboxClient(URL);
|
||||
let tool = await client.loadTool("my-tool")
|
||||
|
||||
const authTool = tool.addAuthTokenGetter("my_auth", get_auth_token) // Single token
|
||||
|
||||
// OR
|
||||
|
||||
const multiAuthTool = tool.addAuthTokenGetters({
|
||||
"my_auth_1": getAuthToken1,
|
||||
"my_auth_2": getAuthToken2,
|
||||
}) // Multiple tokens
|
||||
```
|
||||
|
||||
#### Option B: Add Authentication While Loading Tools
|
||||
|
||||
You can provide the token retriever(s) directly during the `loadTool` or
|
||||
`loadToolset` calls. This applies the authentication configuration only to the
|
||||
tools loaded in that specific call, without modifying the original tool objects
|
||||
if they were loaded previously.
|
||||
|
||||
```javascript
|
||||
const authTool = await toolbox.loadTool("toolName", {"myAuth": getAuthToken})
|
||||
|
||||
// OR
|
||||
|
||||
const authTools = await toolbox.loadToolset({"myAuth": getAuthToken})
|
||||
```
|
||||
|
||||
{{< notice note>}}
|
||||
Adding auth tokens during loading only affect the tools loaded within that call.
|
||||
{{< /notice >}}
|
||||
|
||||
### Complete Authentication Example
|
||||
|
||||
```javascript
|
||||
import { ToolboxClient } from '@toolbox-sdk/adk';
|
||||
|
||||
async function getAuthToken() {
|
||||
// ... Logic to retrieve ID token (e.g., from local storage, OAuth flow)
|
||||
// This example just returns a placeholder. Replace with your actual token retrieval.
|
||||
return "YOUR_ID_TOKEN" // Placeholder
|
||||
}
|
||||
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
let client = new ToolboxClient(URL);
|
||||
const tool = await client.loadTool("my-tool");
|
||||
const authTool = tool.addAuthTokenGetters({"my_auth": getAuthToken});
|
||||
const result = await authTool.runAsync(args: {input:"some input"});
|
||||
console.log(result);
|
||||
```
|
||||
|
||||
## Binding Parameter Values
|
||||
|
||||
The SDK allows you to pre-set, or "bind", values for specific tool parameters
|
||||
before the tool is invoked or even passed to an LLM. These bound values are
|
||||
fixed and will not be requested or modified by the LLM during tool use.
|
||||
|
||||
### Why Bind Parameters?
|
||||
|
||||
- **Protecting sensitive information:** API keys, secrets, etc.
|
||||
- **Enforcing consistency:** Ensuring specific values for certain parameters.
|
||||
- **Pre-filling known data:** Providing defaults or context.
|
||||
|
||||
{{< notice note>}}
|
||||
The parameter names used for binding (e.g., `"api_key"`) must exactly match the parameter names defined in the tool's configuration within the Toolbox service.
|
||||
{{< /notice >}}
|
||||
|
||||
{{< notice note>}}
|
||||
You do not need to modify the tool's configuration in the Toolbox service to
|
||||
> bind parameter values using the SDK.
|
||||
{{< /notice >}}
|
||||
|
||||
### Option A: Binding Parameters to a Loaded Tool
|
||||
|
||||
Bind values to a tool object *after* it has been loaded. This modifies the
|
||||
specific tool instance.
|
||||
|
||||
```javascript
|
||||
|
||||
import { ToolboxClient } from '@toolbox-sdk/adk';
|
||||
|
||||
const URL = 'http://127.0.0.1:5000';
|
||||
let client = new ToolboxClient(URL);
|
||||
const tool = await client.loadTool("my-tool");
|
||||
|
||||
const boundTool = tool.bindParam("param", "value");
|
||||
|
||||
// OR
|
||||
|
||||
const boundTool = tool.bindParams({"param": "value"});
|
||||
```
|
||||
|
||||
### Option B: Binding Parameters While Loading Tools
|
||||
|
||||
Specify bound parameters directly when loading tools. This applies the binding
|
||||
only to the tools loaded in that specific call.
|
||||
|
||||
```javascript
|
||||
const boundTool = await client.loadTool("my-tool", null, {"param": "value"})
|
||||
|
||||
// OR
|
||||
|
||||
const boundTools = await client.loadToolset(null, {"param": "value"})
|
||||
```
|
||||
|
||||
{{< notice note>}}
|
||||
Bound values during loading only affect the tools loaded in that call.
|
||||
{{< /notice >}}
|
||||
|
||||
### Binding Dynamic Values
|
||||
|
||||
Instead of a static value, you can bind a parameter to a synchronous or
|
||||
asynchronous function. This function will be called *each time* the tool is
|
||||
invoked to dynamically determine the parameter's value at runtime.
|
||||
|
||||
```javascript
|
||||
|
||||
async function getDynamicValue() {
|
||||
// Logic to determine the value
|
||||
return "dynamicValue";
|
||||
}
|
||||
|
||||
const dynamicBoundTool = tool.bindParam("param", getDynamicValue)
|
||||
```
|
||||
|
||||
{{< notice note>}}
|
||||
You don't need to modify tool configurations to bind parameter values.
|
||||
{{< /notice >}}
|
||||
|
||||
# Using with ADK
|
||||
|
||||
ADK JS:
|
||||
|
||||
```javascript
|
||||
import {FunctionTool, InMemoryRunner, LlmAgent} from '@google/adk';
|
||||
import {Content} from '@google/genai';
|
||||
import {ToolboxClient} from '@toolbox-sdk/core'
|
||||
|
||||
const toolboxClient = new ToolboxClient("http://127.0.0.1:5000");
|
||||
const loadedTools = await toolboxClient.loadToolset();
|
||||
|
||||
export const rootAgent = new LlmAgent({
|
||||
name: 'weather_time_agent',
|
||||
model: 'gemini-2.5-flash',
|
||||
description:
|
||||
'Agent to answer questions about the time and weather in a city.',
|
||||
instruction:
|
||||
'You are a helpful agent who can answer user questions about the time and weather in a city.',
|
||||
tools: loadedTools,
|
||||
});
|
||||
|
||||
async function main() {
|
||||
const userId = 'test_user';
|
||||
const appName = rootAgent.name;
|
||||
const runner = new InMemoryRunner({agent: rootAgent, appName});
|
||||
const session = await runner.sessionService.createSession({
|
||||
appName,
|
||||
userId,
|
||||
});
|
||||
|
||||
const prompt = 'What is the weather in New York? And the time?';
|
||||
const content: Content = {
|
||||
role: 'user',
|
||||
parts: [{text: prompt}],
|
||||
};
|
||||
console.log(content);
|
||||
for await (const e of runner.runAsync({
|
||||
userId,
|
||||
sessionId: session.id,
|
||||
newMessage: content,
|
||||
})) {
|
||||
if (e.content?.parts?.[0]?.text) {
|
||||
console.log(`${e.author}: ${JSON.stringify(e.content, null, 2)}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
main().catch(console.error);
|
||||
```
|
||||
@@ -22,4 +22,36 @@ These Python SDKs act as clients for that service. They handle the communication
|
||||
By using these SDKs, you can easily leverage your Toolbox-managed tools directly
|
||||
within your Python applications or AI orchestration frameworks.
|
||||
|
||||
[Github](https://github.com/googleapis/mcp-toolbox-sdk-python)
|
||||
## Which Package Should I Use?
|
||||
|
||||
Choosing the right package depends on how you are building your application:
|
||||
|
||||
* [`toolbox-langchain`](langchain):
|
||||
Use this package if you are building your application using the LangChain or
|
||||
LangGraph frameworks. It provides tools that are directly compatible with the
|
||||
LangChain ecosystem (`BaseTool` interface), simplifying integration.
|
||||
* [`toolbox-llamaindex`](llamaindex):
|
||||
Use this package if you are building your application using the LlamaIndex framework.
|
||||
It provides tools that are directly compatible with the
|
||||
LlamaIndex ecosystem (`BaseTool` interface), simplifying integration.
|
||||
* [`toolbox-core`](core):
|
||||
Use this package if you are not using LangChain/LangGraph or any other
|
||||
orchestration framework, or if you need a framework-agnostic way to interact
|
||||
with Toolbox tools (e.g., for custom orchestration logic or direct use in
|
||||
Python scripts).
|
||||
|
||||
## Available Packages
|
||||
|
||||
This repository hosts the following Python packages. See the package-specific
|
||||
README for detailed installation and usage instructions:
|
||||
|
||||
| Package | Target Use Case | Integration | Path | Details (README) | PyPI Status |
|
||||
| :------ | :---------- | :---------- | :---------------------- | :---------- | :---------
|
||||
| `toolbox-core` | Framework-agnostic / Custom applications | Use directly / Custom | `packages/toolbox-core/` | 📄 [View README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-core/README.md) |  |
|
||||
| `toolbox-langchain` | LangChain / LangGraph applications | LangChain / LangGraph | `packages/toolbox-langchain/` | 📄 [View README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-langchain/README.md) |  |
|
||||
| `toolbox-llamaindex` | LlamaIndex applications | LlamaIndex | `packages/toolbox-llamaindex/` | 📄 [View README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-llamaindex/README.md) |  |
|
||||
|
||||
|
||||
{{< notice note >}}
|
||||
Source code for [python-sdk](https://github.com/googleapis/mcp-toolbox-sdk-python)
|
||||
{{< /notice >}}
|
||||
|
||||
401
docs/en/sdks/python-sdk/langchain/index.md
Normal file
401
docs/en/sdks/python-sdk/langchain/index.md
Normal file
@@ -0,0 +1,401 @@
|
||||
---
|
||||
title: "langchain"
|
||||
type: docs
|
||||
weight: 8
|
||||
description: >
|
||||
Toolbox-langchain SDK for connecting to the MCP Toolbox server and invoking tools programmatically.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The `toolbox-langchain` package provides a Python interface to the MCP Toolbox service, enabling you to load and invoke tools from your own applications.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install toolbox-langchain
|
||||
```
|
||||
## Quickstart
|
||||
|
||||
Here's a minimal example to get you started using
|
||||
[LangGraph](https://langchain-ai.github.io/langgraph/reference/prebuilt/#langgraph.prebuilt.chat_agent_executor.create_react_agent):
|
||||
|
||||
```py
|
||||
from toolbox_langchain import ToolboxClient
|
||||
from langchain_google_vertexai import ChatVertexAI
|
||||
from langgraph.prebuilt import create_react_agent
|
||||
|
||||
async with ToolboxClient("http://127.0.0.1:5000") as toolbox:
|
||||
tools = toolbox.load_toolset()
|
||||
|
||||
model = ChatVertexAI(model="gemini-2.0-flash-001")
|
||||
agent = create_react_agent(model, tools)
|
||||
|
||||
prompt = "How's the weather today?"
|
||||
|
||||
for s in agent.stream({"messages": [("user", prompt)]}, stream_mode="values"):
|
||||
message = s["messages"][-1]
|
||||
if isinstance(message, tuple):
|
||||
print(message)
|
||||
else:
|
||||
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)
|
||||
{{< /notice >}}
|
||||
|
||||
## Usage
|
||||
|
||||
Import and initialize the toolbox client.
|
||||
|
||||
```py
|
||||
from toolbox_langchain import ToolboxClient
|
||||
|
||||
# Replace with your Toolbox service's URL
|
||||
async with ToolboxClient("http://127.0.0.1:5000") as toolbox:
|
||||
```
|
||||
|
||||
## Loading Tools
|
||||
|
||||
### Load a toolset
|
||||
|
||||
A toolset is a collection of related tools. You can load all tools in a toolset
|
||||
or a specific one:
|
||||
|
||||
```py
|
||||
# Load all tools
|
||||
tools = toolbox.load_toolset()
|
||||
|
||||
# Load a specific toolset
|
||||
tools = toolbox.load_toolset("my-toolset")
|
||||
```
|
||||
|
||||
### Load a single tool
|
||||
|
||||
```py
|
||||
tool = toolbox.load_tool("my-tool")
|
||||
```
|
||||
|
||||
Loading individual tools gives you finer-grained control over which tools are
|
||||
available to your LLM agent.
|
||||
|
||||
## Use with LangChain
|
||||
|
||||
LangChain's agents can dynamically choose and execute tools based on the user
|
||||
input. Include tools loaded from the Toolbox SDK in the agent's toolkit:
|
||||
|
||||
```py
|
||||
from langchain_google_vertexai import ChatVertexAI
|
||||
|
||||
model = ChatVertexAI(model="gemini-2.0-flash-001")
|
||||
|
||||
# Initialize agent with tools
|
||||
agent = model.bind_tools(tools)
|
||||
|
||||
# Run the agent
|
||||
result = agent.invoke("Do something with the tools")
|
||||
```
|
||||
|
||||
## Use with LangGraph
|
||||
|
||||
Integrate the Toolbox SDK with LangGraph to use Toolbox service tools within a
|
||||
graph-based workflow. Follow the [official
|
||||
guide](https://langchain-ai.github.io/langgraph/) with minimal changes.
|
||||
|
||||
### Represent Tools as Nodes
|
||||
|
||||
Represent each tool as a LangGraph node, encapsulating the tool's execution within the node's functionality:
|
||||
|
||||
```py
|
||||
from toolbox_langchain import ToolboxClient
|
||||
from langgraph.graph import StateGraph, MessagesState
|
||||
from langgraph.prebuilt import ToolNode
|
||||
|
||||
# Define the function that calls the model
|
||||
def call_model(state: MessagesState):
|
||||
messages = state['messages']
|
||||
response = model.invoke(messages)
|
||||
return {"messages": [response]} # Return a list to add to existing messages
|
||||
|
||||
model = ChatVertexAI(model="gemini-2.0-flash-001")
|
||||
builder = StateGraph(MessagesState)
|
||||
tool_node = ToolNode(tools)
|
||||
|
||||
builder.add_node("agent", call_model)
|
||||
builder.add_node("tools", tool_node)
|
||||
```
|
||||
|
||||
### Connect Tools with LLM
|
||||
|
||||
Connect tool nodes with LLM nodes. The LLM decides which tool to use based on
|
||||
input or context. Tool output can be fed back into the LLM:
|
||||
|
||||
```py
|
||||
from typing import Literal
|
||||
from langgraph.graph import END, START
|
||||
from langchain_core.messages import HumanMessage
|
||||
|
||||
# Define the function that determines whether to continue or not
|
||||
def should_continue(state: MessagesState) -> Literal["tools", END]:
|
||||
messages = state['messages']
|
||||
last_message = messages[-1]
|
||||
if last_message.tool_calls:
|
||||
return "tools" # Route to "tools" node if LLM makes a tool call
|
||||
return END # Otherwise, stop
|
||||
|
||||
builder.add_edge(START, "agent")
|
||||
builder.add_conditional_edges("agent", should_continue)
|
||||
builder.add_edge("tools", 'agent')
|
||||
|
||||
graph = builder.compile()
|
||||
|
||||
graph.invoke({"messages": [HumanMessage(content="Do something with the tools")]})
|
||||
```
|
||||
|
||||
## Manual usage
|
||||
|
||||
Execute a tool manually using the `invoke` method:
|
||||
|
||||
```py
|
||||
result = tools[0].invoke({"name": "Alice", "age": 30})
|
||||
```
|
||||
|
||||
This is useful for testing tools or when you need precise control over tool
|
||||
execution outside of an agent framework.
|
||||
|
||||
## Client to Server Authentication
|
||||
|
||||
This section describes how to authenticate the ToolboxClient itself when
|
||||
connecting to a Toolbox server instance that requires authentication. This is
|
||||
crucial for securing your Toolbox server endpoint, especially when deployed on
|
||||
platforms like Cloud Run, GKE, or any environment where unauthenticated access
|
||||
is restricted.
|
||||
|
||||
This client-to-server authentication ensures that the Toolbox server can verify
|
||||
the identity of the client making the request before any tool is loaded or
|
||||
called. It is different from [Authenticating Tools](#authenticating-tools),
|
||||
which deals with providing credentials for specific tools within an already
|
||||
connected Toolbox session.
|
||||
|
||||
### When is Client-to-Server Authentication Needed?
|
||||
|
||||
You'll need this type of authentication if your Toolbox server is configured to
|
||||
deny unauthenticated requests. For example:
|
||||
|
||||
- Your Toolbox server is deployed on Cloud Run and configured to "Require authentication."
|
||||
- Your server is behind an Identity-Aware Proxy (IAP) or a similar
|
||||
authentication layer.
|
||||
- You have custom authentication middleware on your self-hosted Toolbox server.
|
||||
|
||||
Without proper client authentication in these scenarios, attempts to connect or
|
||||
make calls (like `load_tool`) will likely fail with `Unauthorized` errors.
|
||||
|
||||
### How it works
|
||||
|
||||
The `ToolboxClient` allows you to specify functions (or coroutines for the async
|
||||
client) that dynamically generate HTTP headers for every request sent to the
|
||||
Toolbox server. The most common use case is to add an Authorization header with
|
||||
a bearer token (e.g., a Google ID token).
|
||||
|
||||
These header-generating functions are called just before each request, ensuring
|
||||
that fresh credentials or header values can be used.
|
||||
|
||||
### Configuration
|
||||
|
||||
You can configure these dynamic headers as follows:
|
||||
|
||||
```python
|
||||
from toolbox_langchain import ToolboxClient
|
||||
|
||||
async with ToolboxClient(
|
||||
"toolbox-url",
|
||||
client_headers={"header1": header1_getter, "header2": header2_getter, ...}
|
||||
) as client:
|
||||
```
|
||||
|
||||
### Authenticating with Google Cloud Servers
|
||||
|
||||
For Toolbox servers hosted on Google Cloud (e.g., Cloud Run) and requiring
|
||||
`Google ID token` authentication, the helper module
|
||||
[auth_methods](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-core/src/toolbox_core/auth_methods.py) provides utility functions.
|
||||
|
||||
### Step by Step Guide for Cloud Run
|
||||
|
||||
1. **Configure Permissions**:
|
||||
[Grant](https://cloud.google.com/run/docs/securing/managing-access#service-add-principals)
|
||||
the `roles/run.invoker` IAM role on the Cloud
|
||||
Run service to the principal. This could be your `user account email` or a
|
||||
`service account`.
|
||||
2. **Configure Credentials**
|
||||
- Local Development: Set up
|
||||
[ADC](https://cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).
|
||||
- Google Cloud Environments: When running within Google Cloud (e.g., Compute
|
||||
Engine, GKE, another Cloud Run service, Cloud Functions), ADC is typically
|
||||
configured automatically, using the environment's default service account.
|
||||
3. **Connect to the Toolbox Server**
|
||||
|
||||
```python
|
||||
from toolbox_langchain import ToolboxClient
|
||||
from toolbox_core import auth_methods
|
||||
|
||||
auth_token_provider = auth_methods.aget_google_id_token(URL) # can also use sync method
|
||||
async with ToolboxClient(
|
||||
URL,
|
||||
client_headers={"Authorization": auth_token_provider},
|
||||
) as client:
|
||||
tools = client.load_toolset()
|
||||
|
||||
# Now, you can use the client as usual.
|
||||
```
|
||||
|
||||
|
||||
## Authenticating Tools
|
||||
|
||||
{{< notice info >}}
|
||||
Always use HTTPS to connect your application with the Toolbox service, especially when using tools with authentication configured. Using HTTP exposes your application to serious security risks.
|
||||
{{< /notice >}}
|
||||
|
||||
Some tools require user authentication to access sensitive data.
|
||||
|
||||
### Supported Authentication Mechanisms
|
||||
Toolbox currently supports authentication using the [OIDC
|
||||
protocol](https://openid.net/specs/openid-connect-core-1_0.html) with [ID
|
||||
tokens](https://openid.net/specs/openid-connect-core-1_0.html#IDToken) (not
|
||||
access tokens) for [Google OAuth
|
||||
2.0](https://cloud.google.com/apigee/docs/api-platform/security/oauth/oauth-home).
|
||||
|
||||
### Configure Tools
|
||||
|
||||
Refer to [these
|
||||
instructions](https://googleapis.github.io/genai-toolbox/resources/tools/#authenticated-parameters) on
|
||||
configuring tools for authenticated parameters.
|
||||
|
||||
### Configure SDK
|
||||
|
||||
You need a method to retrieve an ID token from your authentication service:
|
||||
|
||||
```py
|
||||
async def get_auth_token():
|
||||
# ... Logic to retrieve ID token (e.g., from local storage, OAuth flow)
|
||||
# This example just returns a placeholder. Replace with your actual token retrieval.
|
||||
return "YOUR_ID_TOKEN" # Placeholder
|
||||
```
|
||||
|
||||
#### Add Authentication to a Tool
|
||||
|
||||
```py
|
||||
async with ToolboxClient("http://127.0.0.1:5000") as toolbox:
|
||||
tools = toolbox.load_toolset()
|
||||
|
||||
auth_tool = tools[0].add_auth_token_getter("my_auth", get_auth_token) # Single token
|
||||
|
||||
multi_auth_tool = tools[0].add_auth_token_getters({"auth_1": get_auth_1}, {"auth_2": get_auth_2}) # Multiple tokens
|
||||
|
||||
# OR
|
||||
|
||||
auth_tools = [tool.add_auth_token_getter("my_auth", get_auth_token) for tool in tools]
|
||||
```
|
||||
|
||||
#### Add Authentication While Loading
|
||||
|
||||
```py
|
||||
auth_tool = toolbox.load_tool(auth_token_getters={"my_auth": get_auth_token})
|
||||
|
||||
auth_tools = toolbox.load_toolset(auth_token_getters={"my_auth": get_auth_token})
|
||||
```
|
||||
{{< notice note >}}
|
||||
Adding auth tokens during loading only affect the tools loaded within that call.
|
||||
{{< /notice >}}
|
||||
|
||||
### Complete Example
|
||||
|
||||
```py
|
||||
import asyncio
|
||||
from toolbox_langchain import ToolboxClient
|
||||
|
||||
async def get_auth_token():
|
||||
# ... Logic to retrieve ID token (e.g., from local storage, OAuth flow)
|
||||
# This example just returns a placeholder. Replace with your actual token retrieval.
|
||||
return "YOUR_ID_TOKEN" # Placeholder
|
||||
|
||||
async with ToolboxClient("http://127.0.0.1:5000") as toolbox:
|
||||
tool = toolbox.load_tool("my-tool")
|
||||
|
||||
auth_tool = tool.add_auth_token_getter("my_auth", get_auth_token)
|
||||
result = auth_tool.invoke({"input": "some input"})
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Binding Parameter Values
|
||||
|
||||
Predetermine values for tool parameters using the SDK. These values won't be
|
||||
modified by the LLM. This is useful for:
|
||||
|
||||
* **Protecting sensitive information:** API keys, secrets, etc.
|
||||
* **Enforcing consistency:** Ensuring specific values for certain parameters.
|
||||
* **Pre-filling known data:** Providing defaults or context.
|
||||
|
||||
### Binding Parameters to a Tool
|
||||
|
||||
```py
|
||||
async with ToolboxClient("http://127.0.0.1:5000") as toolbox:
|
||||
tools = toolbox.load_toolset()
|
||||
|
||||
bound_tool = tool[0].bind_param("param", "value") # Single param
|
||||
|
||||
multi_bound_tool = tools[0].bind_params({"param1": "value1", "param2": "value2"}) # Multiple params
|
||||
|
||||
# OR
|
||||
|
||||
bound_tools = [tool.bind_param("param", "value") for tool in tools]
|
||||
```
|
||||
|
||||
### Binding Parameters While Loading
|
||||
|
||||
```py
|
||||
bound_tool = toolbox.load_tool("my-tool", bound_params={"param": "value"})
|
||||
|
||||
bound_tools = toolbox.load_toolset(bound_params={"param": "value"})
|
||||
```
|
||||
{{< notice note >}}
|
||||
Bound values during loading only affect the tools loaded in that call.
|
||||
{{< /notice >}}
|
||||
|
||||
### Binding Dynamic Values
|
||||
|
||||
Use a function to bind dynamic values:
|
||||
|
||||
```py
|
||||
def get_dynamic_value():
|
||||
# Logic to determine the value
|
||||
return "dynamic_value"
|
||||
|
||||
dynamic_bound_tool = tool.bind_param("param", get_dynamic_value)
|
||||
```
|
||||
{{< notice note >}}
|
||||
You don’t need to modify tool configurations to bind parameter values.
|
||||
{{< /notice >}}
|
||||
|
||||
## Asynchronous Usage
|
||||
|
||||
For better performance through [cooperative
|
||||
multitasking](https://en.wikipedia.org/wiki/Cooperative_multitasking), you can
|
||||
use the asynchronous interfaces of the `ToolboxClient`.
|
||||
|
||||
{{< notice note >}}
|
||||
Asynchronous interfaces like `aload_tool` and `aload_toolset` require an asynchronous environment. For guidance on running asynchronous Python programs, see [asyncio documentation](https://docs.python.org/3/library/asyncio-runner.html#running-an-asyncio-program).
|
||||
{{< /notice >}}
|
||||
|
||||
```py
|
||||
import asyncio
|
||||
from toolbox_langchain import ToolboxClient
|
||||
|
||||
async def main():
|
||||
async with ToolboxClient("http://127.0.0.1:5000") as toolbox:
|
||||
tool = await client.aload_tool("my-tool")
|
||||
tools = await client.aload_toolset()
|
||||
response = await tool.ainvoke()
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
```
|
||||
Reference in New Issue
Block a user