mirror of
https://github.com/encounter/adk-python.git
synced 2026-07-09 18:19:28 -07:00
docs: Fix missing toolbox-core dependency and improve installation guide
Merge https://github.com/google/adk-python/pull/1195 ## Summary Updated the Toolbox Agent documentation to address a critical missing dependency that prevents the agent from running successfully. ## Changes Made - **Added missing dependency**: Documented that `toolbox-core` must be installed via `pip install toolbox-core` - **Improved documentation structure**: Added clear section numbering and better organization - **Enhanced readability**: Fixed grammar, capitalization, and formatting throughout - **Added Prerequisites section**: Set clear expectations before installation begins - **Clarified optional steps**: Made it clearer when database creation can be skipped ## Problem Solved The original documentation was missing a crucial step - installing the `toolbox-core` package. Without this dependency, users encounter an `ImportError: No module named 'toolbox-core'` when trying to use the `ToolboxToolset` class in ADK. This fix ensures users can successfully set up and run the agent without encountering import errors. ## Testing - Verified the installation steps work correctly with the added dependency - Confirmed the agent runs successfully after following the updated documentation COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/1195 from designcomputer:patch-1 b90c71fe95aa09a3dca069e91f14791f557ab2e3 PiperOrigin-RevId: 785487495
This commit is contained in:
committed by
Copybara-Service
parent
3643b4ae19
commit
2486349268
@@ -1,11 +1,18 @@
|
||||
# Toolbox Agent
|
||||
|
||||
This agent is utilizing [mcp toolbox for database](https://googleapis.github.io/genai-toolbox/getting-started/introduction/) to assist end user based on the informaton stored in database.
|
||||
Follow below steps to run this agent
|
||||
This agent utilizes [MCP toolbox for database](https://googleapis.github.io/genai-toolbox/getting-started/introduction/) to assist end users based on information stored in a database.
|
||||
|
||||
# Install toolbox
|
||||
Follow the steps below to run this agent.
|
||||
|
||||
* Run below command:
|
||||
## Prerequisites
|
||||
|
||||
Before starting, ensure you have Python installed on your system.
|
||||
|
||||
## Installation Steps
|
||||
|
||||
### 1. Install Toolbox
|
||||
|
||||
Run the following command to download and install the toolbox:
|
||||
|
||||
```bash
|
||||
export OS="linux/amd64" # one of linux/amd64, darwin/arm64, darwin/amd64, or windows/amd64
|
||||
@@ -13,20 +20,29 @@ curl -O https://storage.googleapis.com/genai-toolbox/v0.5.0/$OS/toolbox
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
# install SQLite
|
||||
### 2. Install SQLite
|
||||
|
||||
* install sqlite from https://sqlite.org/
|
||||
Install SQLite from [https://sqlite.org/](https://sqlite.org/)
|
||||
|
||||
### 3. Install Required Python Dependencies
|
||||
|
||||
# Create DB (optional. The db instance is already attached in the folder)
|
||||
**Important**: The ADK's `ToolboxToolset` class requires the `toolbox-core` package, which is not automatically installed with the ADK. Install it using:
|
||||
|
||||
* Run below command:
|
||||
```bash
|
||||
pip install toolbox-core
|
||||
```
|
||||
|
||||
### 4. Create Database (Optional)
|
||||
|
||||
*Note: A database instance is already included in the project folder. Skip this step if you want to use the existing database.*
|
||||
|
||||
To create a new database:
|
||||
|
||||
```bash
|
||||
sqlite3 tool_box.db
|
||||
```
|
||||
|
||||
* Run below SQL:
|
||||
Run the following SQL commands to set up the hotels table:
|
||||
|
||||
```sql
|
||||
CREATE TABLE hotels(
|
||||
@@ -39,7 +55,6 @@ CREATE TABLE hotels(
|
||||
booked BIT NOT NULL
|
||||
);
|
||||
|
||||
|
||||
INSERT INTO hotels(id, name, location, price_tier, checkin_date, checkout_date, booked)
|
||||
VALUES
|
||||
(1, 'Hilton Basel', 'Basel', 'Luxury', '2024-04-22', '2024-04-20', 0),
|
||||
@@ -54,21 +69,27 @@ VALUES
|
||||
(10, 'Comfort Inn Bern', 'Bern', 'Midscale', '2024-04-04', '2024-04-16', 0);
|
||||
```
|
||||
|
||||
# create tools configurations
|
||||
### 5. Create Tools Configuration
|
||||
|
||||
* Create a yaml file named "tools.yaml", see its contents in the agent folder.
|
||||
Create a YAML file named `tools.yaml`. See the contents in the agent folder for reference.
|
||||
|
||||
# start toolbox server
|
||||
### 6. Start Toolbox Server
|
||||
|
||||
* Run below commands in the agent folder
|
||||
Run the following command in the agent folder:
|
||||
|
||||
```bash
|
||||
toolbox --tools-file "tools.yaml"
|
||||
```
|
||||
|
||||
# start ADK web UI
|
||||
The server will start at `http://127.0.0.1:5000` by default.
|
||||
|
||||
# send user query
|
||||
### 7. Start ADK Web UI
|
||||
|
||||
* query 1: what can you do for me ?
|
||||
* query 2: could you let know the information about "Hilton Basel" hotel ?
|
||||
Follow the ADK documentation to start the web user interface.
|
||||
|
||||
## Testing the Agent
|
||||
|
||||
Once everything is set up, you can test the agent with these sample queries:
|
||||
|
||||
- **Query 1**: "What can you do for me?"
|
||||
- **Query 2**: "Could you let me know the information about 'Hilton Basel' hotel?"
|
||||
|
||||
Reference in New Issue
Block a user