Agent skill

Add Related Resources

by pingcap in pingcap/docs

Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

Custom licenceAuto-check passedDocuments & Office

Install Add Related Resources

skills CLI
$ npx skills add pingcap/docs --skill add-related-resources -a claude-code

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

GitHub CLI
$ gh skill install pingcap/docs add-related-resources --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/pingcap/docs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/add-related-resources .claude/skills/add-related-resources && 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
add-related-resources
GitHub stars
615
Token cost
~1.8k tokens
SKILL.md length
716 words
Files
3 (incl. scripts)
Skills in repo
8
Repo updated
First seen
Licence
Custom licence

At a glance

Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

  • Works in 7 steps: Identify target file(s), source URL(s),… → Read each target file and find the merge… → For each source URL, run… → …
  • The user asks to add
  • SKILL.md covers Overview, Component syntax, Language heading mapping and Card attributes, plus 4 more sections
  • Runs Python scripts from its folder; calls python3; reaches labs.tidb.io and lab-static.pingcap.com

What it does

Add Related Resources is an agent skill from pingcap/docs. Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components. Use when the user asks to add or update a related resource card, resource link, blog card, video card, YouTube card, or TiDB Lab card in English, Simplified Chinese, or Japanese Markdown docs.

Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including scripts (for example `scripts/fetch_resource_metadata.py` and `scripts/validate_related_resources.py`).

It sits in Documents & Office, covering Markdown. It works with TiDB and YouTube. The repository describes itself as: TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

When your agent uses it

  • The user asks to add
  • Update a related resource card
  • TiDB Lab card in English
  • Simplified Chinese

Example prompts

  • “Use the add-related-resources skill to produce and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard…”
  • “/add-related-resources”

Requirements

  • Python 3

Workflow steps

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

  1. Identify target file(s), source URL(s), resource type(s), and target language.
  2. Read each target file and find the merge location: an existing Related resources block, or the end of the file if the container section…
  3. For each source URL, run scripts/fetch_resource_metadata.py with the target language.
  4. Review the JSON draft. Ask the user if a required value is unavailable, a localized URL is missing, or a substitution/fallback is needed.
  5. Merge the card into the target file: append to an existing block, or create the final localized h2 container and place the card inside it.
  6. Verify formatting with
  7. Fix validation errors and rerun the validator until it prints OK.

What it can do on your machine

Read from SKILL.md and the folder at commit c90b204. 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

    Ships 2 files in scripts/ (Python), which the agent can run.

    Shell commands in SKILL.md call:

    • python3

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

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • labs.tidb.io
    • lab-static.pingcap.com
    • i.ytimg.com
    • labs.pingcap.com
    • pingcap.com
    • pingkai.cn
    • pingcap.co.jp
    • youtube.com

    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

Add Related Resources loads about 1.8k tokens when it runs. Until then it costs about 85 tokens; SKILL.md has 716 words of instructions outside code blocks.

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

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); the scripts in this folder are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 716 words (~1,808 tokens).

“A "Related resources" section is a final h2 in a TiDB docs page, containing a block with one or more entries. Each card links to a blog post, YouTube video, or TiDB Lab.”

— opening of SKILL.md by pingcap, Custom licence
name
add-related-resources

Read the full SKILL.md on GitHub

Files

SKILL.md and 2 other files (scripts) in .agents/skills/add-related-resources of pingcap/docs.

  • SKILL.md
  • scripts/fetch_resource_metadata.py
  • scripts/validate_related_resources.py

Open the folder on GitHubat commit c90b204

Compare with similar skills

Add Related Resources 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.

Add Related Resources compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Add Related Resources this skillpingcap/docs615—~1.8kAutomated safety check: PassCustom licence
MarkitdownImCa0/just-laws78214 repos~3.2kAutomated safety check: NotesMIT
Crosspostingwasp-lang/wasp19k—~1.1kAutomated safety check: PassMIT
Lecture To Mdysyecust/lecture-to-notes273—~3.9kAutomated safety check: PassCustom licence
Gbro Series Vocabpyang5166/gbro-series-vocab162—~1.1kAutomated safety check: PassMIT
Markdown Converterintellectronica/agent-skills2954 repos~492Automated safety check: PassCC0-1.0

Similar skills

  • Markitdown

    ImCa0/just-laws

    Convert files and office documents to Markdown. An agent skill from ImCa0/just-laws.

    782 GitHub starsUsed in 14 repos~3.2k tokens
    Documents & OfficeAuto-check: notes
  • Crossposting

    wasp-lang/wasp

    Crosspost Wasp blog articles (MDX) to DEV.to and Medium. An agent skill from wasp-lang/wasp.

    19k GitHub stars~1.1k tokensUpdated yesterday
    Documents & OfficeAuto-check passed
  • Lecture To Md

    ysyecust/lecture-to-notes

    把课堂视频(本地或 B 站/YouTube)、文字稿、课件三者(任意组合)整理成一份详细的中文 Markdown 课堂笔记,输出按课程标题命名的 {titlename}.md(首行为 文档标题)+ 相对路径图片。Markdown 工作流,与上游 lecture-to-notes 的 LaTeX/PDF 输出并行存在;上游 skill 完全不动。触发词:markdown 笔记、md 笔记、视频转…

    273 GitHub stars~3.9k tokensUpdated 6 days ago
    Documents & OfficeAuto-check passed
  • Gbro Series Vocab

    pyang5166/gbro-series-vocab

    追剧学英语 / Learn English vocabulary from TV series. An agent skill from pyang5166/gbro-series-vocab.

    162 GitHub stars~1.1k tokensUpdated 2 mo ago
    Documents & OfficeAuto-check passed
  • Markdown Converter

    intellectronica/agent-skills

    Convert documents and files to Markdown using markitdown. An agent skill from intellectronica/agent-skills.

    295 GitHub starsUsed in 4 repos~492 tokens
    Documents & OfficeAuto-check passed
  • Markdown Converter

    steipete/agent-scripts

    Markdown conversion: PDF, Office, HTML, data, OCR, audio, ZIP, YouTube.

    7.3k GitHub stars~525 tokensUpdated 4 days ago
    Documents & OfficeAuto-check passed

More from pingcap/docs

All 8 skills in this repo
  • Release Notes

    pingcap/docs

    Evaluate whether a change needs a release note. An agent skill from pingcap/docs.

    615 GitHub stars~2.6k tokensUpdated today
    Auto-check passed
  • Create or update a zh translation PR from pingcap/docs to pingcap/docs-cn by using repo-local scripts to prepare change-unit translation inputs, apply minimal edits to the existing Chinese files…

    615 GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

    615 GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.

    615 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • A skill your agent uses when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow.

    615 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…

    615 GitHub stars~1.9k tokensUpdated today
    Auto-check passed

Works with

Questions about Add Related Resources

What does Add Related Resources do?

Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components. Add Related Resources is an agent skill from pingcap/docs. Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

When should I use Add Related Resources?

Add Related Resources fits situations like: the user asks to add; update a related resource card; tiDB Lab card in English; simplified Chinese.

How do I install Add Related Resources in Claude Code?

Run `npx skills add pingcap/docs --skill add-related-resources -a claude-code`. Or copy the skill folder (.agents/skills/add-related-resources in pingcap/docs) into .claude/skills/add-related-resources in your project. Claude Code loads it when a task matches its description.

How do I install Add Related Resources in Codex?

Run `npx skills add pingcap/docs --skill add-related-resources -a codex`. Or copy the skill folder (.agents/skills/add-related-resources in pingcap/docs) into .agents/skills/add-related-resources in your project. Codex loads it when a task matches its description.

Can I use Add Related Resources 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 pingcap/docs --skill add-related-resources -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/add-related-resources, .gemini/skills/add-related-resources, .github/skills/add-related-resources and .opencode/skills/add-related-resources in your project.

What does Add Related Resources need to run?

Going by SKILL.md and its folder, Add Related Resources needs Python for the scripts in its folder and the command-line tools its instructions call (python3). Our summary lists: Python 3.

Does Add Related Resources access the network?

SKILL.md names 8 domains. In commands or code: labs.tidb.io, lab-static.pingcap.com, i.ytimg.com, labs.pingcap.com, pingcap.com, pingkai.cn, pingcap.co.jp and youtube.com; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.

Is Add Related Resources 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. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Add Related Resources use?

Add Related Resources has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Add Related Resources use?

About 1.8k tokens (SKILL.md is roughly 7.2k 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 Add Related Resources?

Skills that share tags, products or a category with Add Related Resources: Markitdown (ImCa0/just-laws, 782 stars), Crossposting (wasp-lang/wasp, 19k stars), Lecture To Md (ysyecust/lecture-to-notes, 273 stars) and Gbro Series Vocab (pyang5166/gbro-series-vocab, 162 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Add Related Resources?

pingcap (a GitHub organization) maintains it in pingcap/docs, which has 615 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 9, 2026.

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