@google-cloud/storage-mcp 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -16
- package/dist/bundle.js +25050 -11912
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -23,6 +23,18 @@ bucket and object management. With the Storage MCP server you can:
|
|
|
23
23
|
|
|
24
24
|
<img src="./assets/easy_access_3x.gif" width="80%" alt="Easy Access Demo">
|
|
25
25
|
|
|
26
|
+
- **Perform analytical and aggregation queries on your objects and buckets.** Perform
|
|
27
|
+
aggregations and compute statistics on entire storage inventory using [Storage Insights
|
|
28
|
+
Datasets](https://cloud.google.com/storage/docs/insights/datasets)
|
|
29
|
+
|
|
30
|
+
<img src="./assets/storage_insights_aggregation.gif" width="80%" alt="Easy Access Demo">
|
|
31
|
+
|
|
32
|
+
- **Run advanced filters and searches on your data.** Search and filter your objects
|
|
33
|
+
by file type, size and other metadata fields using [Storage Insights
|
|
34
|
+
Datasets](https://cloud.google.com/storage/docs/insights/datasets)
|
|
35
|
+
|
|
36
|
+
<img src="./assets/storage_insights_filter.gif" width="80%" alt="Easy Access Demo">
|
|
37
|
+
|
|
26
38
|
## 🚀 Getting Started
|
|
27
39
|
|
|
28
40
|
### Prerequisites
|
|
@@ -126,21 +138,24 @@ accidental data loss.
|
|
|
126
138
|
Safe tools are read-only or only create new objects without affecting existing
|
|
127
139
|
ones. They will never modify or delete existing data in GCS.
|
|
128
140
|
|
|
129
|
-
| Tool
|
|
130
|
-
|
|
|
131
|
-
| `list_buckets`
|
|
132
|
-
| `get_bucket_metadata`
|
|
133
|
-
| `get_bucket_location`
|
|
134
|
-
| `view_iam_policy`
|
|
135
|
-
| `check_iam_permissions`
|
|
136
|
-
| `create_bucket`
|
|
137
|
-
| `list_objects`
|
|
138
|
-
| `read_object_metadata`
|
|
139
|
-
| `read_object_content`
|
|
140
|
-
| `download_object`
|
|
141
|
-
| `write_object_new`
|
|
142
|
-
| `upload_object_new`
|
|
143
|
-
| `copy_object_new`
|
|
141
|
+
| Tool | Description |
|
|
142
|
+
| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |
|
|
143
|
+
| `list_buckets` | Lists all buckets in a project. |
|
|
144
|
+
| `get_bucket_metadata` | Gets comprehensive metadata for a specific bucket. |
|
|
145
|
+
| `get_bucket_location` | Gets the location of a bucket. |
|
|
146
|
+
| `view_iam_policy` | Views the IAM policy for a bucket. |
|
|
147
|
+
| `check_iam_permissions` | Tests IAM permissions for a bucket. |
|
|
148
|
+
| `create_bucket` | Creates a new bucket. Fails if the bucket already exists. |
|
|
149
|
+
| `list_objects` | Lists objects in a GCS bucket. |
|
|
150
|
+
| `read_object_metadata` | Reads comprehensive metadata for a specific object. |
|
|
151
|
+
| `read_object_content` | Reads the content of a specific object. |
|
|
152
|
+
| `download_object` | Downloads an object from GCS to a local file. |
|
|
153
|
+
| `write_object_new` | Writes a new object. Fails if the object already exists. |
|
|
154
|
+
| `upload_object_new` | Uploads a file to a new object. Fails if the object already exists. |
|
|
155
|
+
| `copy_object_new` | Copies an object to a new destination. Fails if the destination already exists. |
|
|
156
|
+
| `get_metadata_table_schema` | Checks if GCS insights service is enabled and returns the BigQuery table schema for a given insights dataset configuration. |
|
|
157
|
+
| `execute_insights_query` | Executes a BigQuery SQL query against an insights dataset and returns the result. |
|
|
158
|
+
| `list_insights_configs` | Lists the names of all Storage Insights dataset configurations for a given project. |
|
|
144
159
|
|
|
145
160
|
### Destructive Tools
|
|
146
161
|
|
|
@@ -179,7 +194,7 @@ We welcome contributions! Whether you're fixing bugs, sharing feedback, or
|
|
|
179
194
|
improving documentation, your contributions are welcome. Please read our
|
|
180
195
|
[Contributing Guide](CONTRIBUTING.md) to get started.
|
|
181
196
|
|
|
182
|
-
## 🎬
|
|
197
|
+
## 🎬 Demos
|
|
183
198
|
|
|
184
199
|
<p align="center"><b>Click to watch the Storage MCP demo</b><br/>
|
|
185
200
|
<a href="./assets/storage_mcp_demo.mp4" title="Click to play demo">
|
|
@@ -187,6 +202,12 @@ improving documentation, your contributions are welcome. Please read our
|
|
|
187
202
|
</a>
|
|
188
203
|
</p>
|
|
189
204
|
|
|
205
|
+
<p align="center"><b>Click to watch the Storage MCP demo powered by Storage Insights</b><br/>
|
|
206
|
+
<a href="./assets/storage_insights_demo.mp4" title="Click to play demo">
|
|
207
|
+
<img width="80%" alt="Storage Insights MCP Demo Video" src="./assets/storage_insights_demo_thumbnail.png">
|
|
208
|
+
</a>
|
|
209
|
+
</p>
|
|
210
|
+
|
|
190
211
|
## 📄 Important Notes
|
|
191
212
|
|
|
192
213
|
This repository is currently in preview and may see breaking changes. This
|