volcengine-mongodb

Skill Overview

This Skill is used in conversations to act as an intelligent operations agent for Volcano Engine MongoDB:

• Understand the user's natural language requirements(Chinese or English), and identify whether they are related to MongoDB;
• Directly call the built-in script scripts/call_mongodb.py to query MongoDB in real time and obtain results;
• When results are obtained or the user pastes error information,further explain, diagnose, and provide follow-up suggestions。

Working Modes:

• Use the scripts/call_mongodb.py script to directly obtain MongoDB's real-time responses

How to Run: The script supports two ways to run:

# 方式 1: 使用 uv (推荐，自动管理依赖)
uv run ./scripts/call_mongodb.py [action] [options]

Method 2: Use python (dependencies need to be installed in advance)

python ./scripts/call_mongodb.py [action] [options]

## 标准使用流程

1. **确认任务类型与参数**
    - 判断用户意图:查询实例列表、查看实例详情、管理备份、查看参数配置等。
    - 收集必要参数(如未指定则使用默认值):
        - `--region`:地域 ID(默认 `cn-beijing`)
        - `--action`:操作类型(如 `list-instances`、`describe-instance`、`list-backups` 等)
        - `--instance-id`:实例 ID(部分操作必需)

2. **构造查询并调用脚本**
   - 示例（以下命令可使用 `uv run` 或 `python` 运行）:
     ```bash
     # 查询实例列表
     uv run ./scripts/call_mongodb.py list-instances

     # 查询指定实例详情
     uv run ./scripts/call_mongodb.py describe-instance --instance-id mongo-xxx

     # 查询实例备份
     uv run ./scripts/call_mongodb.py list-backups --instance-id mongo-xxx

     # 查询实例参数
     uv run ./scripts/call_mongodb.py list-parameters --instance-id mongo-xxx
     ```

3. **解析结果并后续处理**
    - 将 MongoDB 的响应用自然语言解释给用户;
    - 如返回包含敏感操作,评估风险并提醒:
        - 避免在生产环境直接执行高风险操作(如删除实例、重启等);
        - 建议在测试环境验证或做好备份。

## 工具脚本使用说明

### 支持的操作(Actions)

| 操作 | 说明 | 必需参数 |
|------|------|----------|
| `list-instances` | 查询 MongoDB 实例列表 | 无 |
| `describe-instance` | 查询指定实例详情 | `--instance-id` |
| `list-backups` | 查询实例备份 | `--instance-id` |
| `list-parameters` | 查询实例参数配置 | `--instance-id` |

### 命令行参数

| 参数 | 说明 | 默认值 |
|------|------|--------|
| `action` | 操作类型(必需) | - |
| `--region` / `-r` | 火山引擎地域 ID | `cn-beijing` |
| `--instance-id` / `-i` | 实例 ID | 无 |
| `--page-number` | 分页页码 | `1` |
| `--page-size` | 每页记录数 | `10` |
| `--output` / `-o` | 输出格式(json/table) | `json` |

### 输出格式

脚本会将查询信息输出到 `stderr`,将结果输出到 `stdout`,便于分离日志和结果:

[Operation] list-instances [Region] cn-beijing

[Query Result] <actual result content>

## 常见使用场景

### 1. 查看所有实例
```bash
uv run ./scripts/call_mongodb.py list-instances

2. View instance details

uv run ./scripts/call_mongodb.py describe-instance --instance-id mongo-xxx

3. View instance backups

uv run ./scripts/call_mongodb.py list-backups --instance-id mongo-xxx

4. View instance parameter configuration

uv run ./scripts/call_mongodb.py list-parameters --instance-id mongo-xxx

Environment Variable Configuration

1. Obtain Volcano Engine access credentials: refer to User Guide to obtain AK/SK

2. Configure the following environment variables:

export VOLCENGINE_ACCESS_KEY="your-access-key"
export VOLCENGINE_SECRET_KEY="your-secret-key"
export VOLCENGINE_REGION="cn-beijing"  # 可选，默认 cn-beijing