architecture-visualization-governance

Files (30)

• CODEBUDDY.md
• PUBLISH_GUIDE.md
• README.md
• SKILL.md
• _meta.json
• API 概览.md · advisor-2020-07-21/
• category_i18n.json · advisor-2020-07-21/
• 开启智能顾问授权.md · advisor-2020-07-21/云架构控制台相关接口/
• 更新历史.md · advisor-2020-07-21/
• 简介.md · advisor-2020-07-21/
• 公共参数.md · advisor-2020-07-21/调用方式/
• 参数类型.md · advisor-2020-07-21/调用方式/
• 签名方法 v3.md · advisor-2020-07-21/调用方式/
• 签名方法.md · advisor-2020-07-21/调用方式/
• 请求结构.md · advisor-2020-07-21/调用方式/
• 返回结果.md · advisor-2020-07-21/调用方式/
• 错误码.md · advisor-2020-07-21/
• check_env.py
• CreateAdvisorAuthorization.md · references/api/
• DescribeArch.md · references/api/
• DescribeArchList.md · references/api/
• DescribeLastEvaluation.md · references/api/
• DescribeStrategies.md · references/api/
• ListDirectoryV2.md · references/api/
• ListUnorganizedDirectory.md · references/api/
• cleanup.py · scripts/
• create_role.py · scripts/
• login_url.py · scripts/
• setup_role.py · scripts/
• tcloud_api.py · scripts/

SKILL.md (first lines)

# ☁️ 腾讯云智能顾问助手

核心能力：通过 **AK/SK 鉴权**调用腾讯云智能顾问（Tencent Cloud Smart Advisor）API，管理云架构图的目录与详情、获取架构评估结果，以及查询风险评估项。

---

## 一、鉴权方式

使用腾讯云 API **AK/SK 签名认证**（TC3-HMAC-SHA256），通过环境变量配置密钥：

### 1.1 必填环境变量

- `TENCENTCLOUD_SECRET_ID` — 腾讯云 SecretId（必填）
- `TENCENTCLOUD_SECRET_KEY` — 腾讯云 SecretKey（必填）

密钥获取地址：https://console.cloud.tencent.com/cam/capi

**环境变量必须永久写入 shell 配置文件**，确保新会话中仍然生效：

Linux / macOS（写入 `~/.bashrc` 或 `~/.zshrc`）：
```bash
echo 'export TENCENTCLOUD_SECRET_ID="your-secret-id"' >> ~/.bashrc
echo 'export TENCENTCLOUD_SECRET_KEY="your-secret-key"' >> ~/.bashrc
source ~/.bashrc
```

Windows PowerShell（写入用户级环境变量）：
```powershell
[Environment]::SetEnvironmentVariable("TENCENTCLOUD_SECRET_ID", "your-secret-id", "User")
[Environment]::SetEnvironmentVariable("TENCENTCLOUD_SECRET_KEY", "your-secret-key", "User")
```

### 1.2 角色配置（免密登录需要）

为生成控制台免密登录链接，需要配置 CAM 角色。角色配置分为 **检测** 和 **创建** 两个独立步骤，角色创建属于 IAM 写入操作，**必须在用户明确同意后才能执行**。

#### 步骤一：环境检测（只读）

运行环境自检脚本，检测依赖、版本更新、密钥、角色配置状态：

```bash
python3 {baseDir}/check_env.py
```

自检脚本 **仅做只读检测**，不会创建或修改任何资源。返回码含义：
- `0` = 环境就绪（密钥 + 角色全部正常）
- `1` = Python 版本不满足要求
- `2` = AK/SK 未配置或无效
- `3` = 角色未配置（需要执行步骤二）
- `4` = Skill 版本过旧，请更新 Skill

脚本首次运行时会自动检查本地 `_meta.json` 中的版本号与远端最新版本是否一致，若发现新版本则提示更新并退出（返回码 `4`）。可通过 `--skip-update` 参数跳过版本检查。

#### 步骤二：角色创建（需用户同意）

当 `check_env.py` 返回码为 `3`（角色未配置）时，**必须**向用户展示角色创建方案并等待同意：

**向用户说明以下内容**：
1. 将创建 CAM 角色 `advisor`，仅用于免密登录控制台查看智能顾问信息
2. 将关联策略 `QcloudAdvisorFullAccess`（智能顾问只读访问权限，不影响其他云资源）
3. 信任策略仅允许当前账号扮演此角色
4. 用户可随时在 CAM 控制台删除此角色

**用户同意后**，执行角色创建脚本：

```bash
python3 {baseDir}/scripts/create_role.py
```

脚本输出 JSON 格式结果，`success: true` 表示创建成功并已保存配置。

**用户拒绝时**，提供手动配置方式（方式二、三、四）。

#### 方式二：配置向导（交互式选择已有角色）

运行配置向导，从已有角色中选择，或交互式创建新角色：

```bash
python3 {baseDir}/scripts/setup_role.py
```

#### 方式三：简化配置

只需提供角色名称，系统自动获取账号 UIN。将以下内容写入 shell 配置文件（如 `~/.bashrc` 或 `~/.zshrc`）：

```bash
echo 'export TENCENTCLOUD_ROLE_NAME="advisor"' >> ~/.bashrc
source ~/.bashrc
```

系统会自动调用 API 获取您的账号 UIN，并拼接完整的 roleArn。

#### 方式四：完整配置（高级用户）

手动设置完整的角色 ARN，写入 shell 配置文件（如 `~/.bashrc` 或 `~/.zshrc`）：

```bash
echo 'export TENCENTCLOUD_ROLE_ARN="qcs::cam::uin/100001234567:roleName/advisor"' >> ~/.bashrc
source ~/.bashrc
```

### 1.3 可选环境变量

- `TENCENTCLOUD_TOKEN` — 临时密钥 Token（使用临时密钥时设置）
- `TENCENTCLOUD_ROLE_SESSION` — 角色会话名称（默认 `advisor-session`）
- `TENCENTCLOUD_STS_DURATION` — 临时凭证有效期秒数（默认 `3600`，即 1 小时；最大 `43200`，即 12 小时）

> **注意**：所有环境变量均需永久写入 shell 配置文件（如 `~/.bashrc`、`~/.zshrc`），`export` 仅对当前会话生效，新开会话会丢失。

### 1.4 配置优先级

系统按以下优先级加载角色配置：

1. 环境变量 `TENCENTCLOUD_ROLE_ARN`（完整 ARN）
2. 配置文件 `~/.tencent-cloudq/config.json`
3. 环境变量 `TENCENTCLOUD_ROLE_NAME` + 自动获取账号 UIN

---

From LeoYeAI/openclaw-master-skills, MIT.

More from LeoYeAI/openclaw-master-skills