Agent skill

Docs Issue Metadata Guard

by pingcap in pingcap/docs

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.

Custom licenceAuto-check passed

Install Docs Issue Metadata Guard

skills CLI
$ npx skills add pingcap/docs --skill docs-issue-metadata-guard -a claude-code

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

GitHub CLI
$ gh skill install pingcap/docs docs-issue-metadata-guard --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/docs-issue-metadata-guard .claude/skills/docs-issue-metadata-guard && 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
docs-issue-metadata-guard
GitHub stars
616
Token cost
~1.8k tokens
SKILL.md length
931 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
Custom licence

At a glance

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.

  • Works in 5 steps: Write issue titles and descriptions in… → Search existing issues first before… → Choose the correct issue template based… → …
  • Editing GitHub issues in pingcap/docs so issue templates
  • SKILL.md covers Issue templates, Scope boundary, Workflow and Editing existing issues, plus 4 more sections
  • Calls gh

What it does

Docs Issue Metadata Guard is an agent skill from pingcap/docs. Use when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow. Trigger on tasks involving issue creation, error reports, change requests, questions, label selection, or searching for existing issues before filing a new one.

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

It works with TiDB and GitHub. 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

  • Editing GitHub issues in pingcap/docs so issue templates
  • Required fields
  • Scope boundaries
  • Labels stay consistent with repository workflow

Example prompts

  • “/docs-issue-metadata-guard”

Workflow steps

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

  1. Write issue titles and descriptions in English.
  2. Search existing issues first before filing a new one.
  3. Choose the correct issue template based on the issue type.
  4. When using gh issue create
  5. Fill in all template fields with concrete information.

What it can do on your machine

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

    Shell commands in SKILL.md call:

    • gh

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

  • Network

    No URLs in SKILL.md. Its commands use gh, which can reach the network depending on how they are called.

    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

Docs Issue Metadata Guard loads about 1.8k tokens when it runs. Until then it costs about 88 tokens; SKILL.md has 931 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~88
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); files beside SKILL.md 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 931 words (~1,777 tokens).

“Use this skill for pingcap/docs GitHub issue metadata work. The goal is to preserve issue-template structure, scope discipline, and searchable issue descriptions.”

— opening of SKILL.md by pingcap, Custom licence
name
docs-issue-metadata-guard

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/docs-issue-metadata-guard of pingcap/docs.

Open the folder on GitHubat commit 6ba8576

Compare with similar skills

Docs Issue Metadata Guard 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.

Docs Issue Metadata Guard compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Issue Metadata Guard this skillpingcap/docs616—~1.8kAutomated safety check: PassCustom licence
TiDB Issue Metadata Guardpingcap/tidb41k—~1kAutomated safety check: PassApache-2.0
TiDB PR Metadata Guardpingcap/tidb41k—~703Automated safety check: PassApache-2.0
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0
Diagnosing Superpowers Sessionsobra/superpowers296k3 repos~1.7kAutomated safety check: PassMIT
GitHub Deep Researchbytedance/deer-flow83k5 repos~1.3kAutomated safety check: PassMIT

Similar skills

  • Keeps TiDB GitHub issues consistent by following the issue templates, writing reproducible reports, checking for duplicates and applying labels explicitly.

    41k GitHub stars~1k tokensUpdated today
    DevelopmentAuto-check passed
  • Creates and edits TiDB pull request titles and descriptions without breaking the PR template, and diagnoses bot labels that stay on because of template changes.

    41k GitHub stars~703 tokensUpdated today
    DevelopmentAuto-check passed
  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Investigates a session where Superpowers went wrong, reads the transcripts on disk and produces an evidence-cited report, optionally prepared as a bug report for the maintainers.

    296k GitHub starsUsed in 3 repos~1.7k tokens
    Agent WorkflowsAuto-check passed
  • GitHub Deep Research

    bytedance/deer-flow

    Researches a GitHub repository over four rounds using the GitHub API and web search, then writes a structured markdown report with timeline, metrics and Mermaid diagrams.

    83k GitHub starsUsed in 5 repos~1.3k tokens
    Research & ScienceAuto-check passed
  • Greploop

    onyx-dot-app/onyx

    Iteratively improves a PR (GitHub), MR (GitLab), or shelved changelist (Perforce) until Greptile gives it a 5/5 confidence score with zero unresolved comments.

    32k GitHub starsUsed in 4 repos~3.3k tokens
    DevelopmentAuto-check passed

More from pingcap/docs

All 8 skills in this repo
  • Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • Release Notes

    pingcap/docs

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

    616 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…

    616 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.

    616 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.

    616 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…

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

Works with

Questions about Docs Issue Metadata Guard

What does Docs Issue Metadata Guard do?

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. Docs Issue Metadata Guard is an agent skill from pingcap/docs. Use when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow.

When should I use Docs Issue Metadata Guard?

Docs Issue Metadata Guard fits situations like: editing GitHub issues in pingcap/docs so issue templates; required fields; scope boundaries; labels stay consistent with repository workflow.

How do I install Docs Issue Metadata Guard in Claude Code?

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

How do I install Docs Issue Metadata Guard in Codex?

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

Can I use Docs Issue Metadata Guard 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 docs-issue-metadata-guard -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-issue-metadata-guard, .gemini/skills/docs-issue-metadata-guard, .github/skills/docs-issue-metadata-guard and .opencode/skills/docs-issue-metadata-guard in your project.

What does Docs Issue Metadata Guard need to run?

Going by SKILL.md and its folder, Docs Issue Metadata Guard needs the command-line tools its instructions call (gh).

Does Docs Issue Metadata Guard access the network?

SKILL.md contains no URLs. Its commands use gh, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Docs Issue Metadata Guard 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 Docs Issue Metadata Guard use?

Docs Issue Metadata Guard 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 Docs Issue Metadata Guard use?

About 1.8k tokens (SKILL.md is roughly 7.1k 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 Docs Issue Metadata Guard?

Skills that share tags, products or a category with Docs Issue Metadata Guard: TiDB Issue Metadata Guard (pingcap/tidb, 41k stars), TiDB PR Metadata Guard (pingcap/tidb, 41k stars), PR Babysitter (openinterpreter/openinterpreter, 69k stars) and Diagnosing Superpowers Sessions (obra/superpowers, 296k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Issue Metadata Guard?

pingcap (a GitHub organization) maintains it in pingcap/docs, which has 616 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 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.