chore: import upstream snapshot with attribution
Continuous Integration / Pre-commit Linter (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.10) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.11) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.12) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.12) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Has been cancelled
Copybara PR Handler / close-imported-pr (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / Pre-commit Linter (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.10) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.11) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.12) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.12) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Has been cancelled
Copybara PR Handler / close-imported-pr (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,103 @@
|
||||
# GCS Admin Tools Sample
|
||||
|
||||
## Introduction
|
||||
|
||||
This sample agent demonstrates the Google Cloud Storage (GCS) administrative tools in ADK,
|
||||
distributed via the `google.adk.integrations.gcs` module. These tools include:
|
||||
|
||||
1. `gcs_list_buckets`
|
||||
|
||||
List GCS bucket names in a Google Cloud project.
|
||||
|
||||
1. `gcs_create_bucket`
|
||||
|
||||
Create a new GCS bucket.
|
||||
|
||||
1. `gcs_update_bucket`
|
||||
|
||||
Update properties of a GCS bucket.
|
||||
|
||||
1. `gcs_delete_bucket`
|
||||
|
||||
Delete a GCS bucket.
|
||||
|
||||
## How to use
|
||||
|
||||
Set up environment variables in your `.env` file for using
|
||||
[Google AI Studio](https://google.github.io/adk-docs/get-started/quickstart/#gemini---google-ai-studio)
|
||||
or
|
||||
[Google Cloud Vertex AI](https://google.github.io/adk-docs/get-started/quickstart/#gemini---google-cloud-vertex-ai)
|
||||
for the LLM service for your agent. For example, for using Google AI Studio you
|
||||
would set:
|
||||
|
||||
- GOOGLE_GENAI_USE_ENTERPRISE=FALSE
|
||||
- GOOGLE_API_KEY={your api key}
|
||||
|
||||
### With Application Default Credentials (gcloud)
|
||||
|
||||
This is the easiest way to use your own Google Cloud identity for both the tools AND the LLM.
|
||||
|
||||
1. Install the [Google Cloud CLI](https://cloud.google.com/sdk/docs/install).
|
||||
1. Run `gcloud auth application-default login` in your terminal.
|
||||
1. Configure your environment to use Vertex AI (which supports ADC) instead of AI Studio:
|
||||
- `export GOOGLE_GENAI_USE_ENTERPRISE=TRUE`
|
||||
- `export GOOGLE_CLOUD_PROJECT={your-project-id}`
|
||||
1. Ensure the Vertex AI API is enabled and you have also the correct permissions:
|
||||
- Enable API: `gcloud services enable aiplatform.googleapis.com`
|
||||
- Grant Role: `gcloud projects add-iam-policy-binding {your-project-id} --member="user:{your-email}" --role="roles/aiplatform.user"`
|
||||
1. Set `CREDENTIALS_TYPE = None` in `agent.py`.
|
||||
1. Run the agent.
|
||||
|
||||
### With Service Account Keys
|
||||
|
||||
This mode is useful for quick development when the agent builder wants to run
|
||||
the agent with service account credentials. The tools are run with these
|
||||
credentials.
|
||||
|
||||
1. Create service account key by following https://cloud.google.com/iam/docs/service-account-creds#user-managed-keys.
|
||||
|
||||
1. Set `CREDENTIALS_TYPE=AuthCredentialTypes.SERVICE_ACCOUNT` in `agent.py`
|
||||
|
||||
1. Download the key file and replace `"service_account_key.json"` with the path
|
||||
|
||||
1. Run the agent
|
||||
|
||||
### With Interactive OAuth
|
||||
|
||||
1. Follow
|
||||
https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name.
|
||||
to get your client id and client secret. Be sure to choose "web" as your client
|
||||
type.
|
||||
|
||||
1. Follow https://developers.google.com/workspace/guides/configure-oauth-consent
|
||||
to add scope "https://www.googleapis.com/auth/cloud-platform" and
|
||||
"https://www.googleapis.com/auth/devstorage.full_control" as a declaration, this is used
|
||||
for review purpose.
|
||||
|
||||
1. Follow
|
||||
https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred
|
||||
to add http://localhost/dev-ui/ to "Authorized redirect URIs".
|
||||
|
||||
Note: localhost here is just a hostname that you use to access the dev ui,
|
||||
replace it with the actual hostname you use to access the dev ui.
|
||||
|
||||
1. For 1st run, allow popup for localhost in Chrome.
|
||||
|
||||
1. Configure your `.env` file to add two more variables before running the
|
||||
agent:
|
||||
|
||||
- OAUTH_CLIENT_ID={your client id}
|
||||
- OAUTH_CLIENT_SECRET={your client secret}
|
||||
|
||||
Note: don't create a separate .env, instead put it to the same .env file that
|
||||
stores your Vertex AI or Dev ML credentials
|
||||
|
||||
1. Set `CREDENTIALS_TYPE=AuthCredentialTypes.OAUTH2` in `agent.py` and run the
|
||||
agent
|
||||
|
||||
## Sample prompts
|
||||
|
||||
- List all buckets in the my-project project.
|
||||
- Create a new bucket named my-bucket in my-project.
|
||||
- Enable versioning and uniform bucket-level access on my-bucket.
|
||||
- Delete the GCS bucket my-bucket.
|
||||
@@ -0,0 +1,15 @@
|
||||
# Copyright 2026 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from . import agent
|
||||
@@ -0,0 +1,81 @@
|
||||
# Copyright 2026 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
import os
|
||||
|
||||
from google.adk.agents.llm_agent import LlmAgent
|
||||
from google.adk.auth.auth_credential import AuthCredentialTypes
|
||||
from google.adk.integrations.gcs import GCSAdminToolset
|
||||
from google.adk.integrations.gcs.gcs_credentials import GCSCredentialsConfig
|
||||
from google.adk.integrations.gcs.settings import Capabilities
|
||||
from google.adk.integrations.gcs.settings import GCSToolSettings
|
||||
import google.auth
|
||||
|
||||
# Define an appropriate credential type.
|
||||
# Set to None to use Application Default Credentials (ADC).
|
||||
# This is the recommended way to use your `gcloud` credentials locally:
|
||||
# Run `gcloud auth application-default login` in your terminal first.
|
||||
CREDENTIALS_TYPE = None
|
||||
|
||||
# Define GCS admin tool config (default is READ_ONLY; add Capabilities.READ_WRITE for modification access)
|
||||
tool_settings = GCSToolSettings(capabilities=[Capabilities.READ_WRITE])
|
||||
|
||||
if CREDENTIALS_TYPE == AuthCredentialTypes.OAUTH2:
|
||||
# Initialize the tools to do interactive OAuth
|
||||
# The environment variables OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET
|
||||
# must be set
|
||||
credentials_config = GCSCredentialsConfig(
|
||||
client_id=os.getenv("OAUTH_CLIENT_ID"),
|
||||
client_secret=os.getenv("OAUTH_CLIENT_SECRET"),
|
||||
scopes=[
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/devstorage.full_control",
|
||||
],
|
||||
)
|
||||
elif CREDENTIALS_TYPE == AuthCredentialTypes.SERVICE_ACCOUNT:
|
||||
# Initialize the tools to use the credentials in the service account key.
|
||||
# If this flow is enabled, make sure to replace the file path with your own
|
||||
# service account key file
|
||||
# https://cloud.google.com/iam/docs/service-account-creds#user-managed-keys
|
||||
creds, _ = google.auth.load_credentials_from_file("service_account_key.json")
|
||||
credentials_config = GCSCredentialsConfig(credentials=creds)
|
||||
else:
|
||||
# Initialize the tools to use the application default credentials.
|
||||
# https://cloud.google.com/docs/authentication/provide-credentials-adc
|
||||
application_default_credentials, _ = google.auth.default()
|
||||
credentials_config = GCSCredentialsConfig(
|
||||
credentials=application_default_credentials
|
||||
)
|
||||
|
||||
gcs_admin_toolset = GCSAdminToolset(
|
||||
credentials_config=credentials_config, gcs_tool_settings=tool_settings
|
||||
)
|
||||
|
||||
# The variable name `root_agent` determines what your root agent is for the
|
||||
# debug CLI
|
||||
root_agent = LlmAgent(
|
||||
model="gemini-2.5-flash",
|
||||
name="gcs_admin",
|
||||
description=(
|
||||
"Agent to assist with Google Cloud Storage (GCS) administrative tasks"
|
||||
" such as listing buckets."
|
||||
),
|
||||
instruction="""\
|
||||
You are a GCS admin agent with access to GCS administrative tools.
|
||||
Make use of those tools to assist the user with bucket management tasks.
|
||||
""",
|
||||
tools=[
|
||||
gcs_admin_toolset,
|
||||
],
|
||||
)
|
||||
Reference in New Issue
Block a user