Skip to content

Commit 0a85d54

Browse files
docs: cleanup README (#295)
* docs: cleanup README * adk readme cleanup v1 * core readme cleanup v1 * update toolbox link * Apply suggestions from code review Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> * Fix typo in README.md usage section --------- Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com>
1 parent 2494cbc commit 0a85d54

File tree

3 files changed

+34
-1040
lines changed

3 files changed

+34
-1040
lines changed

README.md

Lines changed: 16 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -9,90 +9,42 @@ Logo](https://raw.githubusercontent.com/googleapis/genai-toolbox/main/logo.png)
99
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=flat&logo=discord&logoColor=white)](https://discord.gg/Dmm69peqjh)
1010
[![Medium](https://img.shields.io/badge/Medium-12100E?style=flat&logo=medium&logoColor=white)](https://medium.com/@mcp_toolbox)
1111

12-
This repository contains JS SDKs designed to seamlessly integrate the
13-
functionalities of the [MCP
14-
Toolbox](https://github.com/googleapis/genai-toolbox) into your Gen AI
15-
applications. These SDKs allow you to load tools defined in Toolbox and use them
16-
as standard JS functions or objects within popular orchestration frameworks
17-
or your custom code.
12+
This repository contains JavaScript SDKs for [MCP Toolbox](https://github.com/googleapis/genai-toolbox). These SDKs allow you to load and use tools defined in your MCP Toolbox server as standard JS functions or objects within your Agentic applications.
1813

19-
This simplifies the process of incorporating external functionalities (like
20-
Databases or APIs) managed by Toolbox into your GenAI applications.
14+
For comprehensive guides, tutorials, and advanced configuration, visit the [Main Documentation Site](https://googleapis.github.io/genai-toolbox/).
2115

2216
<!-- TOC -->
2317

24-
- [Overview](#overview)
25-
- [Which Package Should I Use?](#which-package-should-i-use)
2618
- [Available Packages](#available-packages)
27-
- [Getting Started](#getting-started)
19+
- [Quick Start](#quick-start)
2820
- [Contributing](#contributing)
2921
- [License](#license)
3022
- [Support](#support)
3123

3224
<!-- /TOC -->
3325

34-
## Overview
35-
36-
The MCP Toolbox service provides a centralized way to manage and expose tools
37-
(like API connectors, database query tools, etc.) for use by GenAI applications.
38-
39-
These JS SDKs act as clients for that service. They handle the communication needed to:
40-
41-
* Fetch tool definitions from your running Toolbox instance.
42-
* Provide convenient JS objects or functions representing those tools.
43-
* Invoke the tools (calling the underlying APIs/services configured in Toolbox).
44-
* Handle authentication and parameter binding as needed.
45-
46-
By using these SDKs, you can easily leverage your Toolbox-managed tools directly
47-
within your JS applications or AI orchestration frameworks.
48-
49-
## Which Package Should I Use?
50-
51-
Choosing the right package depends on how you are building your application:
52-
53-
- [`@toolbox-sdk/core`](https://github.com/googleapis/mcp-toolbox-sdk-js/tree/main/packages/toolbox-core):
54-
This is a framework agnostic way to connect the tools to popular frameworks
55-
like Langchain, LlamaIndex and Genkit.
56-
- [`@toolbox-sdk/adk`](https://github.com/googleapis/mcp-toolbox-sdk-js/tree/main/packages/toolbox-adk):
57-
This package provides a seamless way to connect to [Google ADK TS](https://github.com/google/adk-js).
58-
5926
## Available Packages
6027

61-
This repository hosts the following TS packages. See the package-specific
62-
README for detailed installation and usage instructions:
63-
64-
| Package | Target Use Case | Integration | Path | Details (README) | Npm Version |
65-
| :------ | :---------- | :---------- | :---------------------- | :---------- | :---------
66-
| `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) | ![npm](https://img.shields.io/npm/v/@toolbox-sdk/core) |
67-
| `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) | ![npm](https://img.shields.io/npm/v/@toolbox-sdk/adk) |
28+
This repository hosts the following TS packages. Visit the [Main Documentation Site](https://googleapis.github.io/genai-toolbox/sdks/js-sdk/) for detailed installation and usage instructions:
6829

69-
## Getting Started
30+
| Package | Target Use Case | Path | Documentation |
31+
| :------ | :---------- | :--- | :---------- |
32+
| `@toolbox-sdk/core` | Framework-agnostic / Custom apps | `packages/toolbox-core/` | [JS Core Guide](https://googleapis.github.io/genai-toolbox/sdks/js-sdk/core/) |
33+
| `@toolbox-sdk/adk` | ADK applications | `packages/toolbox-adk/` | [JS ADK Guide](https://googleapis.github.io/genai-toolbox/sdks/js-sdk/adk/) |
7034

71-
To get started using Toolbox tools with an application, follow these general steps:
72-
73-
1. **Set up and Run the Toolbox Service:**
74-
75-
Before using the SDKs, you need the main MCP Toolbox service running. Follow
76-
the instructions here: [**Toolbox Getting Started
77-
Guide**](https://github.com/googleapis/genai-toolbox?tab=readme-ov-file#getting-started)
78-
79-
2. **Install the Appropriate SDK:**
80-
81-
Choose the package based on your needs (see "[Which Package Should I Use?](#which-package-should-i-use)" above) and install it:
35+
## Quick Start
8236

37+
1. **Set up the Toolbox Service**: Ensure you have a running MCP Toolbox server. Follow the [Toolbox Server Getting Started Guide](https://github.com/googleapis/genai-toolbox?tab=readme-ov-file#getting-started).
38+
2. **Install the Appropriate SDK**:
8339
```bash
8440
# For the core, framework-agnostic SDK
8541
npm install @toolbox-sdk/core
8642
```
87-
88-
3. **Use the SDK:**
89-
90-
Consult the README for your chosen package (linked in the "[Available
91-
Packages](#available-packages)" section above) for detailed instructions on
92-
how to connect the client, load tool definitions, invoke tools, configure
93-
authentication/binding, and integrate them into your application or
94-
framework.
95-
43+
```bash
44+
# For the ADK SDK
45+
npm install @toolbox-sdk/adk
46+
```
47+
3. **Explore Tutorials**: Check out the [JS Quickstart Tutorial](https://googleapis.github.io/genai-toolbox/getting-started/local_quickstart_js/) for a full walkthrough.
9648
## Contributing
9749

9850
Contributions are welcome! Please refer to the

0 commit comments

Comments
 (0)