cloudsword

CloudSword 是一款面向公有云租户的综合性安全检测与风险发现工具。它提供了基于 MCP 协议的对接方式，支持通过 SSE（服务端事件流）和 STDIO 两种模式与本地或远程 MCP 客户端进行交互，便于在自动化管道和交互式会话中使用。通过云鉴提供的多云资产发现、权限分析、镜像与对象存储相关的安全检查等模块，用户可以快速列出各云提供商的资产、检测潜在的配置风险、并执行防护性策略。使用时，需要设置云提供商的访问凭证（通过环境变量 CLOUD_SWORD_ACCESS_KEY_ID、CLOUD_SWORD_ACCESS_KEY_SECRET、CLOUD_SWORD_SECURITY_TOKEN），然后通过 CloudSword 的交互命令选择模块并执行 run/set 等操作来运行具体的检查任务。SSE 模式将输出结构化的工具信息，STDIO 模式则以文本流的方式与工具进行交互，便于在脚本中捕获结果。你可以使用 help、list、search、use、run 等指令来浏览、选择和执行具体的模块。

准备条件:

1. 一个支持的操作系统（Linux、macOS、Windows 的兼容环境）
2. 基本的命令行工具链
3. 需要的云云凭证及网络访问权限

安装步骤（两种常用方式）:

方式 A：通过 Homebrew（适用于 macOS/Linux）

# 添加官方 tap 并安装 Cloudsword（二进制包）
brew tap wgpsec/tap
brew install cloudsword

方式 B：直接下载二进制发行包

# 访问镜像/发布页，下载对应平台的 cloudsword 二进制
# 解压并放在可执行路径中（例如 /usr/local/bin）
chmod +x cloudsword
mv cloudsword /usr/local/bin/

运行示例（SSE 模式）:

# 启动 CloudSword 的 MCP 服务器端点，默认使用 8080 端口
./cloudsword sse http://localhost:8080

环境变量说明（用于认证与輸出控制）:

export CLOUD_SWORD_ACCESS_KEY_ID=your_access_key_id
export CLOUD_SWORD_ACCESS_KEY_SECRET=your_access_key_secret
export CLOUD_SWORD_SECURITY_TOKEN=your_token_if_applicable
export CLOUD_SWORD_DETAIL=yes  # 或 no

如果你使用的是二进制发行包，请确保已经将执行权限设置好，并将执行文件路径加入到你的 PATH 里。

常见问题与提示:

• 确保 CLOUD_SWORD_ACCESS_KEY_ID/SECRET 对应的云服务账户具备所需的权限；某些操作需要更高权限或临时凭证时，请提供 CLOUD_SWORD_SECURITY_TOKEN。
• SSE 模式会输出结构化信息，便于在监控系统中解析；STDIO 模式适合在交互式会话或脚本中逐步执行模块。
• 使用 help、list、use、run、set、unset 等命令来浏览和执行模块。对于某些模块，使用 set 来配置参数后再执行 run。
• 如果遇到连接问题，请检查本地防火墙与网络代理设置，以及云端 API 的可用性。
• 环境变量 detail 的设为 yes 以获取更详细的输出，帮助调试集成。