cloud-storage-list-objects
2 minute read
About
A cloud-storage-list-objects tool returns the objects in a
Cloud Storage bucket. It supports the usual GCS listing options:
prefix— filter results to objects whose names begin with the given string.delimiter— group results by this character (typically/) so subdirectory-like “common prefixes” are returned separately from the leaf objects.max_results/page_token— paginate through large listings.
The response is a JSON object with objects (the full object metadata as
returned by the Cloud Storage API — fields such as Name, Size, ContentType,
Updated, StorageClass, MD5, etc.), prefixes (the common prefixes when
delimiter is set), and nextPageToken (empty when there are no more pages).
You can set bucket, prefix, or delimiter in the tool configuration. When
set, that field is removed from the runtime parameter schema and the configured
value is always used. A configured bucket must be a non-empty string.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Cloud Storage Source |
Parameters
| parameter | type | required | description |
|---|---|---|---|
| bucket | string | true | Name of the Cloud Storage bucket to list objects from. |
| prefix | string | false | Filter results to objects whose names begin with this prefix. |
| delimiter | string | false | Delimiter used to group object names (typically ‘/’). When set, common prefixes are returned as prefixes. |
| max_results | integer | false | Maximum number of objects 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_objects
type: cloud-storage-list-objects
source: my-gcs-source
description: Use this tool to list objects in a Cloud Storage bucket.
kind: tool
name: list_log_objects
type: cloud-storage-list-objects
source: my-gcs-source
description: Use this tool to list log objects in a Cloud Storage bucket.
bucket: my-log-bucket
prefix: logs/
delimiter: /
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “cloud-storage-list-objects”. |
| source | string | true | Name of the Cloud Storage source to list objects from. |
| description | string | true | Description of the tool that is passed to the LLM. |
| bucket | string | false | Bucket to always list from. When set, the runtime bucket parameter is hidden. Must not be empty. |
| prefix | string | false | Object prefix to always use. When set, the runtime prefix parameter is hidden. |
| delimiter | string | false | Delimiter to always use. When set, the runtime delimiter 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.