Agent skill

Obdiag Usage

by oceanbase in oceanbase/obdiag

obdiag agent 工具使用指南:配置文件生成、gather/analyze/check/rca 各命令的调用方式、参数说明与典型场景。用户询问"怎么用 obdiag"、"如何采集日志"、"怎么生成配置"、"如何巡检/根因分析",或 agent 自身不确定该调哪个工具时加载本 skill。

MulanPSL-2.0Auto-check passedBusiness, Finance & HR

Install Obdiag Usage

skills CLI
$ npx skills add oceanbase/obdiag --skill obdiag-usage -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install oceanbase/obdiag obdiag-usage --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/oceanbase/obdiag.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/agent/skills/obdiag-usage .claude/skills/obdiag-usage && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
obdiag-usage
GitHub stars
163
Token cost
~2.1k tokens
SKILL.md length
549 words
Files
1
Skills in repo
14
Repo updated
First seen
Licence
MulanPSL-2.0

At a glance

obdiag agent 工具使用指南:配置文件生成、gather/analyze/check/rca 各命令的调用方式、参数说明与典型场景。用户询问"怎么用 obdiag"、"如何采集日志"、"怎么生成配置"、"如何巡检/根因分析",或 agent 自身不确定该调哪个工具时加载本 skill。

  • Works in 3 steps: 用户未提供必填项时,逐一追问,不要猜测。 → 已有 config.yml 时,工具会自动备份为… → 生成后用 list_obdiag_clusters 确认写入成功,再继续诊断。
  • Business, Finance & HR work in your project
  • SKILL.md covers 一、配置文件生成(generate_obdiag_config), 二、多集群管理, 三、Gather 采集工具 and 四、Analyze 分析工具, plus 5 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Obdiag Usage is an agent skill from oceanbase/obdiag. obdiag agent 工具使用指南:配置文件生成、gather/analyze/check/rca 各命令的调用方式、参数说明与典型场景。用户询问"怎么用 obdiag"、"如何采集日志"、"怎么生成配置"、"如何巡检/根因分析",或 agent 自身不确定该调哪个工具时加载本 skill。

Its SKILL.md is about 2.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Business, Finance & HR. The repository describes itself as: obdiag (OceanBase Diagnostic Tool) is designed to help OceanBase users quickly gather necessary information and analyze the root cause of the problem.

When your agent uses it

  • Business, Finance & HR work in your project

Example prompts

  • “怎么用 obdiag”
  • “如何采集日志”
  • “怎么生成配置”
  • “/obdiag-usage”

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. 用户未提供必填项时,逐一追问,不要猜测。
  2. 已有 config.yml 时,工具会自动备份为 config.yml.backup_。
  3. 生成后用 list_obdiag_clusters 确认写入成功,再继续诊断。

What it can do on your machine

Read from SKILL.md and the folder at commit e912c58. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Obdiag Usage loads about 2.1k tokens when it runs. Until then it costs about 40 tokens; SKILL.md has 549 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~40
When it runs · the whole SKILL.md, loaded when a task matches
~2.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (MulanPSL-2.0) doesn't allow us to republish the file, so here is its outline and opening line. It has 549 words (~2,133 tokens).

name
obdiag-usage

Read the full SKILL.md on GitHub

Files

Just SKILL.md in plugins/agent/skills/obdiag-usage of oceanbase/obdiag.

Open the folder on GitHubat commit e912c58

Compare with similar skills

Obdiag Usage next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Obdiag Usage compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Obdiag Usage this skilloceanbase/obdiag163—~2.1kAutomated safety check: PassMulanPSL-2.0
Technical Analysttradermonty/claude-trading-skills3k5 repos~4.6kAutomated safety check: PassMIT
Creating Financial ModelsChen-zexi/open-ptc-agent7294 repos~1.3kAutomated safety check: PassMIT
Stock APIzhangxiangliang/stock-api2k—~507Automated safety check: PassMIT
Theme Detectortradermonty/claude-trading-skills3k2 repos~4.9kAutomated safety check: PassMIT
Itr Walakaranb192/itr-wala871—~3.6kAutomated safety check: PassMIT

Similar skills

  • Technical Analyst

    tradermonty/claude-trading-skills

    This skill should be used when analyzing weekly price charts for stocks, stock indices, cryptocurrencies, or forex pairs.

    3k GitHub starsUsed in 5 repos~4.6k tokens
    Business, Finance & HRAuto-check passed
  • Creating Financial Models

    Chen-zexi/open-ptc-agent

    This skill provides an advanced financial modeling suite with DCF analysis, sensitivity testing, Monte Carlo simulations, and scenario planning for investment decisions

    729 GitHub starsUsed in 4 repos~1.3k tokens
    Business, Finance & HRAuto-check passed
  • Stock API

    zhangxiangliang/stock-api

    Fetch real-time stock quotes, K-line (candlestick) history, and search symbols for China A-shares, Hong Kong, and US markets.

    2k GitHub stars~507 tokensUpdated today
    Business, Finance & HRAuto-check passed
  • Theme Detector

    tradermonty/claude-trading-skills

    Detect and analyze trending market themes across sectors. An agent skill from tradermonty/claude-trading-skills.

    3k GitHub starsUsed in 2 repos~4.9k tokens
    Business, Finance & HRAuto-check passed
  • Itr Wala

    karanb192/itr-wala

    File Indian income tax returns (ITR) for FY 2025-26 / AY 2026-27.

    871 GitHub stars~3.6k tokensUpdated 3 days ago
    Business, Finance & HRAuto-check passed
  • Tushare Data

    zillionare/zillionare

    面向中文自然语言的 Tushare 数据研究技能。用于把“看看这只股票最近怎么样”“帮我查财报趋势”“最近哪个板块最强”“北向资金在买什么”“给我导出一份行情数据”这类请求,转成可执行的数据获取、清洗、对比、筛选、导出与简要分析流程。适用于 A 股、指数、ETF/基金、财务、估值、资金流、公告新闻、板块概念与宏观数据等研究场景。

    319 GitHub starsUsed in 2 repos~2.3k tokens
    Business, Finance & HRAuto-check passed

More from oceanbase/obdiag

All 14 skills in this repo
  • 备份、日志归档、物理恢复、恢复时间窗、NFS/OSS/COS 归档路径、对象存储权限、备租户恢复源、obadmin 读取归档位点、oblogminer schemameta 等问题;OMS 迁移同步问题不使用本 skill。

    163 GitHub stars~990 tokensUpdated 4 mo ago
    Auto-check passed
  • Obdiag Rca

    oceanbase/obdiag

    OceanBase 集群所有根因分析场景的统一 SOP。覆盖事务超时/回滚/断连、内存不足、合并卡住、日志盘满、DDL 失败、Schema 泄漏、GC 异常、弱一致性读、OMS 等。始终先执行 rcarun,如 RCA 脚本无法给出结论再按本 skill 降级到手动日志采集分析。

    163 GitHub stars~2.6k tokensUpdated 4 mo ago
    Auto-check passed
  • Obdiag Triage

    oceanbase/obdiag

    未知/未分类问题的统一分诊 SOP:用户描述集群异常但症状不明确、不知从何入手,或问题无法直接对应 rca/observer-log-analysis/observer-sql-analysis 等专项 skill 时,强制先执行全量巡检 checkcluster,再根据巡检结果决定下一步路径。

    163 GitHub stars~662 tokensUpdated 4 mo ago
    Auto-check passed
  • Obproxy Log Analysis

    oceanbase/obdiag

    标准 SOP:OBProxy 日志采集(gatherobproxylog)、包内解读(filelist/fileread/runshell 解压)、可选巡检。用户提到 OBProxy/代理/obproxydiagnosis 等时使用;与 observer 侧 observer-log-analysis 互斥 analyzelog。

    163 GitHub stars~945 tokensUpdated 4 mo ago
    Auto-check passed
  • OBProxy/ODP 连接解析、弱读与只读副本路由、读写分离、分区键解析、SHOW CREATE 兼容、getlock、cluster not exist、2013、Unknown thread id、新建表经代理慢等路由配置类问题;日志采集解读使用 obproxy-log-analysis。

    163 GitHub stars~1.3k tokensUpdated 4 mo ago
    Auto-check passed
  • Observer 侧日志盘、数据盘、磁盘分配失败、-4184、-4264、-4009、Structure needs cleaning、fallocate、合并 -4016、索引或加副本空间不足、单表恢复占盘、归档卡 GC 等存储空间问题;日志链使用 observer-log-analysis。

    163 GitHub stars~1.3k tokensUpdated 4 mo ago
    Auto-check passed

Questions about Obdiag Usage

What does Obdiag Usage do?

obdiag agent 工具使用指南:配置文件生成、gather/analyze/check/rca 各命令的调用方式、参数说明与典型场景。用户询问"怎么用 obdiag"、"如何采集日志"、"怎么生成配置"、"如何巡检/根因分析",或 agent 自身不确定该调哪个工具时加载本 skill。. Obdiag Usage is an agent skill from oceanbase/obdiag.

When should I use Obdiag Usage?

Obdiag Usage fits situations like: business, Finance & HR work in your project.

How do I install Obdiag Usage in Claude Code?

Run `npx skills add oceanbase/obdiag --skill obdiag-usage -a claude-code`. Or copy the skill folder (plugins/agent/skills/obdiag-usage in oceanbase/obdiag) into .claude/skills/obdiag-usage in your project. Claude Code loads it when a task matches its description.

How do I install Obdiag Usage in Codex?

Run `npx skills add oceanbase/obdiag --skill obdiag-usage -a codex`. Or copy the skill folder (plugins/agent/skills/obdiag-usage in oceanbase/obdiag) into .agents/skills/obdiag-usage in your project. Codex loads it when a task matches its description.

Can I use Obdiag Usage in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add oceanbase/obdiag --skill obdiag-usage -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/obdiag-usage, .gemini/skills/obdiag-usage, .github/skills/obdiag-usage and .opencode/skills/obdiag-usage in your project.

What does Obdiag Usage need to run?

SKILL.md names no scripts, command-line tools or credentials: Obdiag Usage is instructions for the agent only.

Does Obdiag Usage access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Obdiag Usage safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Obdiag Usage use?

Obdiag Usage is published under the MulanPSL-2.0 licence (the repository's licence).

How many tokens does Obdiag Usage use?

About 2.1k tokens (SKILL.md is roughly 8.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Obdiag Usage?

Skills that share tags, products or a category with Obdiag Usage: Technical Analyst (tradermonty/claude-trading-skills, 3k stars), Creating Financial Models (Chen-zexi/open-ptc-agent, 729 stars), Stock API (zhangxiangliang/stock-api, 2k stars) and Theme Detector (tradermonty/claude-trading-skills, 3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Obdiag Usage?

oceanbase (a GitHub organization) maintains it in oceanbase/obdiag, which has 163 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on May 19, 2026.

Source: oceanbase/obdiag on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.