huawei-rocketmq
华为云 RocketMQ 实例、Topic、消费组、消费者连接和积压排查。当用户明确排查 Huawei Cloud RocketMQ 时使用, 通过已连接的 huawei-rocketmq MCP 执行只读查询,不用于其他厂商或一般开发问题。
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/key-well--huawei-rocketmq-skill)HTML
<a href="/listings/key-well--huawei-rocketmq-skill"><img src="/api/listings/key-well--huawei-rocketmq-skill/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
要求 macOS/Linux、Git、Python 3.10+、[uv](https://docs.astral.sh/uv/) 和至少一个受支持客户端。
git clone https://github.com/key-well/huawei-rocketmq-skill.git cd huawei-rocketmq-skill ./install.sh --platforms codex # 可选:cursor / claude / opencode,逗号分隔;不指定则安装所有客户端 # ./install.sh --platforms cursor,claude # 自定义运行目录必须为绝对路径或 ~/ 开头 # ./install.sh --platforms codex --install-dir ~/tools/huawei-rocketmq-skill
默认运行目录:`~/.local/share/huawei-rocketmq-skill`。安装在独立 `.venv` 中运行,合并本服务的 MCP 项并备份已有客户端配置;不同服务分别安装,不覆盖其他 MCP 项。不会调用 sudo,也不会自动安装 uv。
| 客户端 | Skill 目录 | MCP 配置 | |---|---|---| | Codex | `~/.agents/skills/huawei-rocketmq` | `~/.codex/config.toml` | | Claude Code | `~/.claude/skills/huawei-rocketmq` | `~/.claude.json` | | Cursor | `~/.cursor/skills/huawei-rocketmq` | `~/.cursor/mcp.json` | | OpenCode | `~/.config/opencode/skills/huawei-rocketmq` | `~/.config/opencode/opencode.json` |
安装后,在本地配置里将下列占位符替换为自己的值,再重启客户端。不要把真实 AK/SK 发到聊天或提交到仓库。
HUAWEI_ACCESS_KEY=REPLACE_WITH_YOUR_AK HUAWEI_SECRET_KEY=REPLACE_WITH_YOUR_SK HUAWEI_REGION=REPLACE_WITH_YOUR_REGION HUAWEI_PROJECT_ID=REPLACE_WITH_YOUR_PROJECT_ID
地域/项目也可由工具调用 `region` / `project_id` 覆盖,优先级高于环境默认值。运行时要求二者完整,不自动跨项目查询。此版本不支持 STS 临时凭证。
建议使用专用、最小只读 IAM 权限;工具白名单限制不替代云端权限管理。安装脚本重复执行会重写本服务的 MCP 项为占位配置,请妥善保留自己的本地配置并重新填入,不要将配置备份提交 Git。
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
SKILL.md · Manifest · 33 lines
- ---
- name: huawei-rocketmq
- description: >-
- 华为云 RocketMQ 实例、Topic、消费组、消费者连接和积压排查。当用户明确排查 Huawei Cloud RocketMQ 时使用,
- 通过已连接的 huawei-rocketmq MCP 执行只读查询,不用于其他厂商或一般开发问题。
- ---
- # Huawei RocketMQ
- ## 开始查询
- 1. 发现当前实际暴露的 MCP 工具名;前缀可能随客户端变化。没有对应工具时说明尚未连接,不虚构云端结果,也不自动改用其他账号或命令行。
- 2. 目标地域、项目按本次请求指定值优先,其次使用服务器的 `HUAWEI_REGION` / `HUAWEI_PROJECT_ID`;缺失或冲突时询问。多个账号需由用户明确选择服务器连接。
- 3. 先识别资源 ID,再缩小时间和分页范围。显示时间要说明时区;参数单位以工具 schema 为准。
- 4. 工具字段是官方 Python SDK 名,嵌套请求使用 `body`,不要传 X-Auth-Token、AK/SK 或原始 HTTP headers。
- ## 排查路径
- - 实例识别:`ListInstances`(必填 `engine="rocketmq"`)→ `ShowInstance`,明确实例 ID 和引擎版本,不能把 Kafka 的 group/offset 语义套用到 RocketMQ。
- - Broker/节点:`ListBrokers`、`ShowInstanceNodes`,结合已有配置 `ShowRocketMqConfigs` 查询。
- - Topic:`ListRocketInstanceTopics` → `ShowOneTopic` / `ShowTopicStatus`;Topic 消息数不能直接当作消费组积压数。
- - 消费组:`ListInstanceConsumerGroups` / `ListConsumerGroupOfTopic` → `ShowGroup` / `ShowConsumerListOrDetails`,根据实际响应解释消费进度、积压及在线状态。
- - 消费者连接:`ShowConsumerConnections`,区分连接数、客户端列表、消费速率和积压趋势;没有字段时说明无法确认。
- - 权限检查:只读 `ListTopicAccessPolicy` / `ListConsumeGroupAccessPolicy`;不要读取用户密钥、修改 ACL 或重置消费进度。
- - 需要消息级取证时先说明本仓库不提供消息正文查询;禁止自动拉取、发送、确认或消费业务消息。趋势指标可关联另一个已连接的 CES MCP。
- ## 边界与交付
- - 不提供消息正文、用户密钥、发送/消费消息、重置消费进度、重试/补发、Topic 变更、实例重启或 ACL 修改。
- - 仓库仅注册明确选择的只读接口,不提供写操作开关。Skill 指令不能替代 IAM/RBAC 权限限制。
- - 不要求用户在聊天中提供密钥,不读取本地凭证文件,也不输出身份凭证。查询结果中的业务 key、连接地址和用户信息只在定位必需时做最小展示。
- - 区分观察事实、推测和未知;返回目标、时间窗、关键计数、代表证据及请求 ID。空列表不是系统正常的充分证据,先核对分页、权限、地域及指标延迟。
- - 身份配置见 [references/identity.md](references/identity.md);工具名和版本见 [references/tools.md](references/tools.md);示例见 [examples/prompts.md](examples/prompts.md)。
README.md · README · 81 lines
- # Huawei RocketMQ Skill + MCP
- 独立的华为云 RocketMQ 只读排障工具,提供 Agent Skill、轻量 Python stdio MCP 服务,以及 Cursor、Claude Code、OpenCode、Codex 的安装/卸载脚本。
- 这是 key-well 维护的社区项目,非华为云官方发布。复用 LTS 项目的安装和适配实现,工具绑定使用华为云官方 Python SDK,无需克隆整套上游 MCP 工程。来源与许可证见 [NOTICE](NOTICE)。
- ## 能力
- 华为云 RocketMQ 实例、Topic、消费组、消费者连接和积压排查,共 **20 个只读查询工具**。完整清单见 [references/tools.md](references/tools.md)。
- 不提供消息正文、用户密钥、发送/消费消息、重置消费进度、重试/补发、Topic 变更、实例重启或 ACL 修改。
- ## 安装
- 要求 macOS/Linux、Git、Python 3.10+、[uv](https://docs.astral.sh/uv/) 和至少一个受支持客户端。
- ```bash
- git clone https://github.com/key-well/huawei-rocketmq-skill.git
- cd huawei-rocketmq-skill
- ./install.sh --platforms codex
- # 可选:cursor / claude / opencode,逗号分隔;不指定则安装所有客户端
- # ./install.sh --platforms cursor,claude
- # 自定义运行目录必须为绝对路径或 ~/ 开头
- # ./install.sh --platforms codex --install-dir ~/tools/huawei-rocketmq-skill
- ```
- 默认运行目录:`~/.local/share/huawei-rocketmq-skill`。安装在独立 `.venv` 中运行,合并本服务的 MCP 项并备份已有客户端配置;不同服务分别安装,不覆盖其他 MCP 项。不会调用 sudo,也不会自动安装 uv。
- | 客户端 | Skill 目录 | MCP 配置 |
- |---|---|---|
- | Codex | `~/.agents/skills/huawei-rocketmq` | `~/.codex/config.toml` |
- | Claude Code | `~/.claude/skills/huawei-rocketmq` | `~/.claude.json` |
- | Cursor | `~/.cursor/skills/huawei-rocketmq` | `~/.cursor/mcp.json` |
- | OpenCode | `~/.config/opencode/skills/huawei-rocketmq` | `~/.config/opencode/opencode.json` |
- 安装后,在本地配置里将下列占位符替换为自己的值,再重启客户端。不要把真实 AK/SK 发到聊天或提交到仓库。
- ```text
- HUAWEI_ACCESS_KEY=REPLACE_WITH_YOUR_AK
- HUAWEI_SECRET_KEY=REPLACE_WITH_YOUR_SK
- HUAWEI_REGION=REPLACE_WITH_YOUR_REGION
- HUAWEI_PROJECT_ID=REPLACE_WITH_YOUR_PROJECT_ID
- ```
- 地域/项目也可由工具调用 `region` / `project_id` 覆盖,优先级高于环境默认值。运行时要求二者完整,不自动跨项目查询。此版本不支持 STS 临时凭证。
- 建议使用专用、最小只读 IAM 权限;工具白名单限制不替代云端权限管理。安装脚本重复执行会重写本服务的 MCP 项为占位配置,请妥善保留自己的本地配置并重新填入,不要将配置备份提交 Git。
- ## 使用
- - 列出指定项目的 RocketMQ 实例并核对运行状态。
- - 排查实例 INSTANCE_ID 的消费组 GROUP_NAME 积压,检查消费者连接和 Topic 状态。
- - 检查实例 INSTANCE_ID 的 Broker、节点和已有配置,不拉取业务消息。
- Skill 中包含服务专属的排查路线和数据边界。CES 监控或 LTS 日志跨服务关联需要分别安装相应 MCP,不会自动连接。
- ## 卸载
- ```bash
- ./uninstall.sh --platforms codex
- # 自定义运行目录时传入与安装时一致的 --install-dir
- ```
- 仅卸载本安装拥有的配置和 Skill,恢复安装前记录的条目;仍有客户端使用时保留运行目录。先前配置备份可能含有本地凭证,请自行安全保管。
- ## 开发与验证
- ```bash
- uv sync --frozen --extra dev
- uv run pytest
- uv run python scripts/generate_tools.py --check
- bash -n install.sh uninstall.sh
- ```
- `references/operations.json` 是显式工具白名单;生成脚本验证 SDK 请求类、方法和 HTTP 方式,并生成已提交的完整 inputSchema。升级依赖后运行 `--write` 更新目录,并审查差异。拒绝未登记操作、未知字段、缺失必填字段和类型不匹配的请求。
- 测试使用假客户端和临时 HOME,不需要云凭证,不会更改真实客户端配置。包含安装/卸载、参数转换、版本路由及 stdio 协议检查。**离线测试通过不等于云端验收通过**;首次使用仍需以自己的只读账号验证地域、权限与实际返回字段。
- ## 许可证
- 主体代码 MIT;保留 LTS 上游版权声明。官方操作清单衍生部分遵守 Apache-2.0,详见 [NOTICE](NOTICE)、[LTS-LICENSE](LTS-LICENSE) 和 `licenses/iaas-mcp-server-LICENSE`。
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.