cloud-storage-list-buckets
2 minute read
About
A cloud-storage-list-buckets tool returns the Cloud Storage buckets in a
project. By default, it uses the project configured on the source. You can pass
the optional project parameter to list buckets in a different project that
the same credentials can access.
You can also set project or prefix in the tool configuration. When set,
that field is removed from the runtime parameter schema and the configured value
is always used. Set project to an empty string to hide the parameter while
using the source’s configured project.
The response is a JSON object with buckets (bucket metadata returned by the
Cloud Storage API) and nextPageToken (empty when there are no more pages).
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Cloud Storage Source |
Parameters
| parameter | type | required | description |
|---|---|---|---|
| project | string | false | Project ID to list buckets in. When empty, the source’s configured project is used. |
| prefix | string | false | Filter results to buckets whose names begin with this prefix. |
| max_results | integer | false | Maximum number of buckets to return per page. A value of 0 uses the API default (1000); negative values and values above 1000 are rejected. |
| page_token | string | false | A previously-returned page token for retrieving the next page of results. |
Example
kind: tool
name: list_buckets
type: cloud-storage-list-buckets
source: my-gcs-source
description: Use this tool to list Cloud Storage buckets in the project.
kind: tool
name: list_log_buckets
type: cloud-storage-list-buckets
source: my-gcs-source
description: Use this tool to list log buckets in the configured project.
project: ""
prefix: logs-
Output Format
The tool returns a JSON object with:
| field | type | description |
|---|---|---|
| buckets | array | Bucket metadata returned by the Cloud Storage API. |
| nextPageToken | string | Token to pass as page_token for the next page. |
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “cloud-storage-list-buckets”. |
| source | string | true | Name of the Cloud Storage source to list buckets from. |
| description | string | true | Description of the tool that is passed to the LLM. |
| project | string | false | Project ID to always use. When set, the runtime project parameter is hidden. An empty string uses the source’s configured project. |
| prefix | string | false | Bucket name prefix to always use. When set, the runtime prefix parameter is hidden. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.