|
1 | 1 | 
|
3 |
| -# MCP Toolbox SDKs for NodeJS |
| 3 | + |
| 4 | +# MCP Toolbox SDKs for JS |
4 | 5 |
|
5 | 6 | [](https://opensource.org/licenses/Apache-2.0)
|
7 | 8 |
|
8 |
| -This repository contains NodeJS SDKs designed to seamlessly integrate the |
| 9 | +This repository contains JS SDKs designed to seamlessly integrate the |
9 | 10 | functionalities of the [MCP
|
10 | 11 | Toolbox](https://github.com/googleapis/genai-toolbox) into your Gen AI
|
11 |
| -applications. |
| 12 | +applications. These SDKs allow you to load tools defined in Toolbox and use them |
| 13 | +as standard JS functions or objects within popular orchestration frameworks |
| 14 | +or your custom code. |
| 15 | + |
| 16 | +This simplifies the process of incorporating external functionalities (like |
| 17 | +Databases or APIs) managed by Toolbox into your GenAI applications. |
| 18 | + |
| 19 | +<!-- TOC --> |
| 20 | + |
| 21 | +- [Overview](#overview) |
| 22 | +- [Which Package Should I Use?](#which-package-should-i-use) |
| 23 | +- [Available Packages](#available-packages) |
| 24 | +- [Getting Started](#getting-started) |
| 25 | +- [Contributing](#contributing) |
| 26 | +- [License](#license) |
| 27 | +- [Support](#support) |
| 28 | + |
| 29 | +<!-- /TOC --> |
| 30 | + |
| 31 | +## Overview |
| 32 | + |
| 33 | +The MCP Toolbox service provides a centralized way to manage and expose tools |
| 34 | +(like API connectors, database query tools, etc.) for use by GenAI applications. |
| 35 | + |
| 36 | +These JS SDKs act as clients for that service. They handle the communication needed to: |
| 37 | + |
| 38 | +* Fetch tool definitions from your running Toolbox instance. |
| 39 | +* Provide convenient JS objects or functions representing those tools. |
| 40 | +* Invoke the tools (calling the underlying APIs/services configured in Toolbox). |
| 41 | +* Handle authentication and parameter binding as needed. |
| 42 | + |
| 43 | +By using these SDKs, you can easily leverage your Toolbox-managed tools directly |
| 44 | +within your JS applications or AI orchestration frameworks. |
| 45 | + |
| 46 | +## Which Package Should I Use? |
| 47 | + |
| 48 | +Choosing the right package depends on how you are building your application: |
| 49 | + |
| 50 | +- [`@toolbox/core`](https://github.com/googleapis/mcp-toolbox-sdk-js/tree/main/packages/toolbox-core): |
| 51 | + This is a framework agnostic way to connect the tools to popular frameworks |
| 52 | + like Langchain, LlamaIndex and Genkit. |
| 53 | + |
| 54 | +## Available Packages |
| 55 | + |
| 56 | +This repository hosts the following TS packages. See the package-specific |
| 57 | +README for detailed installation and usage instructions: |
| 58 | + |
| 59 | +| Package | Target Use Case | Integration | Path | Details (README) | Npm Version | |
| 60 | +| :------ | :---------- | :---------- | :---------------------- | :---------- | :--------- |
| 61 | +| `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) | 0.1.0 | |
| 62 | + |
| 63 | +## Getting Started |
| 64 | + |
| 65 | +To get started using Toolbox tools with an application, follow these general steps: |
| 66 | + |
| 67 | +1. **Set up and Run the Toolbox Service:** |
| 68 | + |
| 69 | + Before using the SDKs, you need the main MCP Toolbox service running. Follow |
| 70 | + the instructions here: [**Toolbox Getting Started |
| 71 | + Guide**](https://github.com/googleapis/genai-toolbox?tab=readme-ov-file#getting-started) |
| 72 | + |
| 73 | +2. **Install the Appropriate SDK:** |
| 74 | + |
| 75 | + Choose the package based on your needs (see "[Which Package Should I Use?](#which-package-should-i-use)" above) and install it: |
| 76 | + |
| 77 | + ```bash |
| 78 | + # For the core, framework-agnostic SDK |
| 79 | + npm install @toolbox/core |
| 80 | + ``` |
| 81 | + |
| 82 | +3. **Use the SDK:** |
| 83 | + |
| 84 | + Consult the README for your chosen package (linked in the "[Available |
| 85 | + Packages](#available-packages)" section above) for detailed instructions on |
| 86 | + how to connect the client, load tool definitions, invoke tools, configure |
| 87 | + authentication/binding, and integrate them into your application or |
| 88 | + framework. |
| 89 | + |
| 90 | +## Contributing |
| 91 | + |
| 92 | +Contributions are welcome! Please refer to the |
| 93 | +[`CONTRIBUTING.md`](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/CONTRIBUTING.md) |
| 94 | +to get started. |
| 95 | + |
| 96 | +## License |
| 97 | + |
| 98 | +This project is licensed under the Apache License 2.0. See the |
| 99 | +[LICENSE](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/LICENSE) file |
| 100 | +for details. |
| 101 | + |
| 102 | +## Support |
12 | 103 |
|
13 |
| -# TODO: Edit readme |
| 104 | +If you encounter issues or have questions, please check the existing [GitHub |
| 105 | +Issues](https://github.com/googleapis/genai-toolbox/issues) for the main Toolbox |
| 106 | +project. If your issue is specific to one of the SDKs, please look for existing |
| 107 | +issues [here](https://github.com/googleapis/mcp-toolbox-sdk-js/issues) or |
| 108 | +open a new issue in this repository. |
0 commit comments