Back to Genai Toolbox

cloud-storage-get-bucket-metadata

docs/en/integrations/cloud-storage/tools/cloud-storage-get-bucket-metadata.md

1.2.01.5 KB
Original Source

About

A cloud-storage-get-bucket-metadata tool returns metadata for a single Cloud Storage bucket. Use it when the LLM needs fields such as location, storage class, labels, lifecycle configuration, or uniform bucket-level access status.

The response is the bucket metadata structure returned by the Cloud Storage API.

Compatible Sources

{{< compatible-sources >}}

Requirements

The Cloud Storage credentials must be able to read metadata for the target bucket.

Parameters

parametertyperequireddescription
bucketstringtrueName of the Cloud Storage bucket to inspect.

Example

yaml
kind: tool
name: get_bucket_metadata
type: cloud-storage-get-bucket-metadata
source: my-gcs-source
description: Use this tool to inspect metadata for a Cloud Storage bucket.

Output Format

The tool returns bucket metadata from the Cloud Storage API, including fields such as Name, Location, StorageClass, Created, Labels, VersioningEnabled, Lifecycle, and UniformBucketLevelAccess.

Reference

fieldtyperequireddescription
typestringtrueMust be "cloud-storage-get-bucket-metadata".
sourcestringtrueName of the Cloud Storage source to get bucket metadata from.
descriptionstringtrueDescription of the tool that is passed to the LLM.