- Notifications
You must be signed in to change notification settings - Fork32
docs(adk): PolishREADME with comprehensive examples#464
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:feat/credential-factories
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
…NTITYAlso fixed broken imports in __init__.py and client.py
3516e5e to295a3c1Comparea9d2c83 to36e0d2dCompare295a3c1 to8cabc61Compare055d710 tofe0d3d7Comparef5c316b tode38a50Comparefe0d3d7 to09b8829Comparede38a50 to532a7c7Compare51e6f74 tof0f7b28CompareImplements the ToolboxToolset class in toolbox-adk.- Wraps ToolboxClient to provide tools to ADK agents.- Supports all standard credential strategies.- Adds support for auth_token_getters to handle tools with custom authSources (runtime token resolution).- Includes unit tests for toolset functionality.
Adds a comprehensive integration test suite for toolbox-adk matching toolbox-core coverage.- Basic E2E: Loading toolsets, running tools.- Parameters: Bound parameters, Map parameters, Optional parameters.- Authentication: Verifies auth_token_getters propagation and error handling.- Input Validation: Verifies correct error types for missing/invalid inputs.
Adds factory methods to CredentialStrategy to easily create configurations from ADK objects.- from_adk_auth_config(auth_config)- from_adk_credentials(scheme, credential)ENSURES strict consistency between ADK auth types and Toolbox credential requirements.
532a7c7 to7355c10CompareUh oh!
There was an error while loading.Please reload this page.
| This package allows Google ADK agents to natively use tools from the MCP Toolbox. | ||
| This package allows Google ADK (Agent Development Kit) agents to natively use tools from the[MCP Toolbox](https://github.com/googleapis/genai-toolbox). | ||
| It provides a seamless bridge between the`toolbox-core` SDK and the ADK's`BaseTool` /`BaseToolset` interfaces, handling authentication propagation, header management, and tool wrapping automatically. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
nit: I like when we have the TOC
| ##Authentication Strategies | ||
| The`toolbox-adk` package provides flexible authentication strategies to handle`Client-to-Server` authentication (securing the connection to the Toolbox server) and`User Identity` propagation (authenticating the user for specific tools). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
nit: don't use backticks around client to server and user identity
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Bold or italics would be nice
| Uses the agent's environment credentials (ADC) to generate an OIDC ID token. This is the standard way for one service to authenticate to another on Google Cloud. | ||
| ```python | ||
| # target_audience should match the URL of your Toolbox server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
nit: add imports to these code snippets too
| ###Workload Identity (Recommended for Cloud Run / GKE) | ||
| Uses the agent's environment credentials (ADC) to generate an OIDC ID token. This is the standard way for one service to authenticate to another on Google Cloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Uses the agent's environment credentials (ADC) to generate an OIDCIDtoken. This is the standard way for one service to authenticate to another on Google Cloud. | |
| Uses the agent's environment credentials (ADC) to generate an OIDC token. This is the standard way for one service to authenticate to another on Google Cloud. |
| Propagates the end-user's identity to the Toolbox. This is used when the tools themselves need to act on behalf of the user (e.g., accessing the user's Drive or Calendar). | ||
| ```python | ||
| creds= CredentialStrategy.user_identity( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Is this passed in to the ToolboxToolset the same as above? I worry about confusing the service to service with end user auth concepts
| ) | ||
| ``` | ||
| ###Global Parameter Binding |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
nit: in the future we should show examples of using the binding
Co-authored-by: Averi Kitsch <akitsch@google.com>
README with comprehensive examples8959c86 toeb3184bCompareeb3184b toe3b4dabCompare
Uh oh!
There was an error while loading.Please reload this page.
Updates
READMEwith complete documentation.