Skip to content

Commit bcfe840

Browse files
authored
update rustfs mcp server available tools (#34)
1 parent a03f85e commit bcfe840

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/en/guide/mcp.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,9 @@ rustfs-mcp --log-level debug --region us-west-2
8787
```
8888

8989
### Integration with chat client
90+
9091
#### Option 1: Using Command Line Arguments
92+
9193
```json
9294
{
9395
"mcpServers": {
@@ -105,6 +107,7 @@ rustfs-mcp --log-level debug --region us-west-2
105107
```
106108

107109
#### Option 2: Using Environment Variables
110+
108111
```json
109112
{
110113
"mcpServers": {
@@ -191,21 +194,26 @@ Trae working with **Builder with MCP** mode calls `list_buckets` tool, and lists
191194
The MCP server exposes the following tools that AI assistants can use:
192195

193196
### `list_buckets`
197+
194198
List all S3 buckets accessible with the configured credentials.
195199

196200
**Parameters:** None
197201

198202
### `list_objects`
203+
199204
List objects in an S3 bucket with optional prefix filtering.
200205

201206
**Parameters:**
207+
202208
- `bucket_name` (string): Name of the S3 bucket
203209
- `prefix` (string, optional): Prefix to filter objects
204210

205211
### `upload_file`
212+
206213
Upload a local file to S3 with automatic MIME type detection.
207214

208215
**Parameters:**
216+
209217
- `local_file_path` (string): Path to the local file
210218
- `bucket_name` (string): Target S3 bucket
211219
- `object_key` (string): S3 object key (destination path)
@@ -214,16 +222,33 @@ Upload a local file to S3 with automatic MIME type detection.
214222
- `cache_control` (string, optional): Cache control header
215223

216224
### `get_object`
225+
217226
Retrieve an object from S3 with two operation modes: read content directly or download to a file.
218227

219228
**Parameters:**
229+
220230
- `bucket_name` (string): Source S3 bucket
221231
- `object_key` (string): S3 object key
222232
- `version_id` (string, optional): Version ID for versioned objects
223233
- `mode` (string, optional): Operation mode - "read" (default) returns content directly, "download" saves to local file
224234
- `local_path` (string, optional): Local file path (required when mode is "download")
225235
- `max_content_size` (number, optional): Maximum content size in bytes for read mode (default: 1MB)
226236

237+
### `create_bucket`
238+
239+
Create a new RustFS bucket.
240+
241+
**Parameters:**
242+
243+
- `bucket_name` (string): Name of the bucket to create.
244+
245+
### `delete_bucket`
246+
247+
Delete a RustFS bucket.
248+
249+
**Parameters:**
250+
251+
- `bucket_name` (string): Name of the bucket to delete.
227252
## Architecture
228253

229254
The MCP server is built with a modular architecture:

docs/zh/guide/mcp.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,21 @@ MCP 服务器公开了 AI 助手可以使用的以下工具:
240240
- `local_path` (字符串, 可选):本地文件路径(当模式为 "download" 时必填)
241241
- `max_content_size` (数字, 可选):读取模式的最大内容大小(字节)(默认:1MB)
242242

243+
### `create_bucket`
244+
245+
创建一个新的 RustFS 存储桶。
246+
247+
**参数**
248+
249+
- `bucket_name` (字符串):要创建的存储桶名称。
250+
251+
### `delete_bucket`
252+
253+
删除指定的 RustFS 存储桶。
254+
255+
**参数**
256+
257+
- `bucket_name` (字符串):要删除的存储桶名称。
243258

244259
## 架构
245260

0 commit comments

Comments
 (0)