mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-04 04:05:22 -05:00
refactor docs
This commit is contained in:
@@ -20,49 +20,6 @@ This simplifies integrating external functionalities (like APIs, databases, or
|
||||
custom logic) managed by the Toolbox into your workflows, especially those
|
||||
involving Large Language Models (LLMs).
|
||||
|
||||
<!-- TOC ignore:true -->
|
||||
<!-- TOC -->
|
||||
|
||||
- [MCP Toolbox Core SDK](#mcp-toolbox-core-sdk)
|
||||
- [Installation](#installation)
|
||||
- [Quickstart](#quickstart)
|
||||
- [Usage](#usage)
|
||||
- [Transport Protocols](#transport-protocols)
|
||||
- [Supported Protocols](#supported-protocols)
|
||||
- [Example](#example)
|
||||
- [Loading Tools](#loading-tools)
|
||||
- [Load a toolset](#load-a-toolset)
|
||||
- [Load a single tool](#load-a-single-tool)
|
||||
- [Invoking Tools](#invoking-tools)
|
||||
- [Client to Server Authentication](#client-to-server-authentication)
|
||||
- [When is Client-to-Server Authentication Needed?](#when-is-client-to-server-authentication-needed)
|
||||
- [How it works](#how-it-works)
|
||||
- [Configuration](#configuration)
|
||||
- [Authenticating with Google Cloud Servers](#authenticating-with-google-cloud-servers)
|
||||
- [Step by Step Guide for Cloud Run](#step-by-step-guide-for-cloud-run)
|
||||
- [Authenticating Tools](#authenticating-tools)
|
||||
- [When is Authentication Needed?](#when-is-authentication-needed)
|
||||
- [Supported Authentication Mechanisms](#supported-authentication-mechanisms)
|
||||
- [Step 1: Configure Tools in Toolbox Service](#step-1-configure-tools-in-toolbox-service)
|
||||
- [Step 2: Configure SDK Client](#step-2-configure-sdk-client)
|
||||
- [Provide an ID Token Retriever Function](#provide-an-id-token-retriever-function)
|
||||
- [Option A: Add Default Authentication to a Client](#option-a-add-default-authentication-to-a-client)
|
||||
- [Option B: Add Authentication to a Loaded Tool](#option-b-add-authentication-to-a-loaded-tool)
|
||||
- [Option C: Add Authentication While Loading Tools](#option-c-add-authentication-while-loading-tools)
|
||||
- [Complete Authentication Example](#complete-authentication-example)
|
||||
- [Binding Parameter Values](#binding-parameter-values)
|
||||
- [Why Bind Parameters?](#why-bind-parameters)
|
||||
- [Option A: Add Default Bound Parameters to a Client](#option-a-add-default-bound-parameters-to-a-client)
|
||||
- [Option B: Binding Parameters to a Loaded Tool](#option-b-binding-parameters-to-a-loaded-tool)
|
||||
- [Option C: Binding Parameters While Loading Tools](#option-c-binding-parameters-while-loading-tools)
|
||||
- [Binding Dynamic Values](#binding-dynamic-values)
|
||||
- [Using with Orchestration Frameworks](#using-with-orchestration-frameworks)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Support](#support)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
@@ -553,27 +510,7 @@ dynamicBoundTool, err := tool.ToolFrom(core.WithBindParamStringFunc("param", get
|
||||
|
||||
# Using with Orchestration Frameworks
|
||||
|
||||
To see how the MCP Toolbox Go SDK works with orchestration frameworks, check out the end-to-end examples in the [/samples/](https://github.com/googleapis/mcp-toolbox-sdk-go/tree/main/core/samples) folder.
|
||||
|
||||
Use the [tbgenkit package](https://github.com/googleapis/mcp-toolbox-sdk-go/tree/main/tbgenkit) to convert Toolbox Tools into Genkit compatible tools.
|
||||
|
||||
# Contributing
|
||||
|
||||
Contributions are welcome! Please refer to the [DEVELOPER.md](https://github.com/googleapis/mcp-toolbox-sdk-go/blob/main/DEVELOPER.md)
|
||||
file for guidelines on how to set up a development environment and run tests.
|
||||
|
||||
# License
|
||||
|
||||
This project is licensed under the Apache License 2.0. See the
|
||||
[LICENSE](https://github.com/googleapis/mcp-toolbox-sdk-go/blob/main/LICENSE) file for details.
|
||||
|
||||
# Support
|
||||
|
||||
If you encounter issues or have questions, check the existing [GitHub Issues](https://github.com/googleapis/genai-toolbox/issues) for the main Toolbox project.
|
||||
|
||||
# Samples for Reference
|
||||
|
||||
These samples demonstrate how to integrate the MCP Toolbox Go Core SDK with popular orchestration frameworks.
|
||||
To see how the MCP Toolbox Go SDK works with orchestration frameworks, check out these end-to-end examples given below.
|
||||
|
||||
<details>
|
||||
<summary>Google GenAI</summary>
|
||||
|
||||
Reference in New Issue
Block a user