Agent skill

Doc Freshness Review

by TencentCloudBase in TencentCloudBase/CloudBase-AI-Toolkit

A skill your agent uses when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under doc/ and key entry…

MITAuto-check passedDevelopment

Install Doc Freshness Review

skills CLI
$ npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review -a claude-code

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

GitHub CLI
$ gh skill install TencentCloudBase/CloudBase-AI-Toolkit doc-freshness-review --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/TencentCloudBase/CloudBase-AI-Toolkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/doc-freshness-review .claude/skills/doc-freshness-review && 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
doc-freshness-review
GitHub stars
1.1k
Token cost
~1.1k tokens
SKILL.md length
536 words
Files
2 (incl. references)
Skills in repo
49
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under doc/ and key entry…

  • Works in 4 steps: Scope the surfaces → Evidence-based comparison → Severity and action → …
  • Auditing repository documentation for drift
  • SKILL.md covers When to use this skill, Workflow, Routing and Evaluation prompts, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Doc Freshness Review is an agent skill from TencentCloudBase/CloudBase-AI-Toolkit. Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under doc/ and key entry surfaces such as README.md (English default), README.zh-CN.md, mcp/README.md, and mcp/README.zh-CN.md during periodic maintenance or before preparing corrective PRs.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/review-scope.md`).

It sits in Development, covering Technical documentation and MCP servers. It works with Model Context Protocol. The repository describes itself as: Backend for AI coding agents on CloudBase — database, auth, functions via Plugin, Skills & MCP. The licence is MIT.

When your agent uses it

  • Auditing repository documentation for drift
  • Stale statements
  • Broken references
  • README mismatches

Example prompts

  • “/doc-freshness-review”

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Scope the surfaces
  2. Evidence-based comparison
  3. Severity and action
  4. Follow-through

What it can do on your machine

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

Doc Freshness Review loads about 1.1k tokens when it runs, and up to ~1.4k if it reads all its reference files. Until then it costs about 92 tokens; SKILL.md has 536 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~92
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.4k

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

The full file from TencentCloudBase/CloudBase-AI-Toolkit at commit 21af91c, republished under its MIT licence (© TencentCloudBase). 536 words, ~1,060 tokens.

Download SKILL.mdSave it as .claude/skills/doc-freshness-review/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
doc-freshness-review
description
Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under `doc/` and key entry surfaces such as `README.md` (English default), `README.zh-CN.md`, `mcp/README.md`, and `mcp/README.zh-CN.md` during periodic maintenance or before preparing corrective PRs.
alwaysApply
false

Documentation Freshness Review

Review whether repository documentation still matches the current code, generated assets, and published entry points.

When to use this skill

Use this skill when you need to:

  • Audit published documentation under doc/ for stale or wrong statements
  • Check whether README.md, README.zh-CN.md, mcp/README.md, or mcp/README.zh-CN.md drifted away from current behavior
  • Verify that linked scripts, files, commands, and workflows still exist and still match the repo
  • Run a periodic docs health check before opening corrective PRs
  • Separate mechanical doc drift from product ambiguity that still needs human confirmation

Do NOT use for:

  • Marketing copy polish without a freshness or correctness question
  • API contract review that depends on CloudBase control-plane docs first
  • Feature planning or architecture design
  • Rewriting large docs from scratch when the main need is a targeted drift audit

Workflow

Phase 1 — Scope the surfaces
  1. Read references/review-scope.md first.
  2. Build the audit surface in two groups:
    • published documentation under doc/
    • README surfaces such as README.md, README.zh-CN.md, and mcp/README.md
  3. Note which code, scripts, generated files, or workflows those docs claim to describe.
Phase 2 — Evidence-based comparison
  1. Verify whether referenced files, scripts, commands, and workflow names still exist.
  2. Compare the docs against the current implementation, generated outputs, and source-of-truth files.
  3. Mark each mismatch as one of:
    • stale statement
    • missing or stale reference
    • outdated command
    • drift between published docs and README surfaces
    • drift between docs and actual implementation
Phase 3 — Severity and action
  1. Prefer concrete findings with exact file paths and the smallest useful rewrite direction.
  2. If the fix is mechanical and low-risk, prepare the doc updates for a focused PR.
  3. If the docs may be wrong because product behavior is unclear, write a report and issue instead of guessing.
  4. If the drift originates from a CloudBase API contract problem, hand off to api-contract-review before updating the prose.
Show full SKILL.md (230 more words)Show less
Phase 4 — Follow-through
  1. Keep report sections separate for:
    • published documentation
    • README surfaces
    • broken or missing references
  2. Prefer one focused PR per coherent doc drift batch.
  3. Route open-PR repair work to pr-review-fix after the doc finding is confirmed.

Routing

TaskRead
Review docs and README freshness scopereferences/review-scope.md
Review CloudBase API contract drift before changing related proseapi-contract-review
Fix an already-open PR after confirming the doc driftpr-review-fix

Evaluation prompts

Should-trigger
  1. Audit doc/ and the main README files for stale commands, missing files, and broken references.
  2. Review whether mcp/README.md still matches the current MCP tool behavior and linked files.
  3. Help me prepare a corrective PR for docs that still reference scripts or workflows that no longer exist.
Should-not-trigger
  1. Review this TypeScript module for runtime validation gaps.
  2. Compare CloudBase action parameters against the official control-plane docs.
  3. Write a brand-new tutorial for a feature that does not exist yet.

Minimum self-check

  • Did I separately review published documentation and README surfaces?
  • Can I point to exact file paths for every stale or broken reference?
  • Did I compare the docs against current code, scripts, and generated outputs instead of relying on memory?
  • If I recommend a fix, is it a small, reviewable doc batch suitable for a PR?
  • If the underlying product behavior was unclear, did I stop at report or issue instead of rewriting confidently?

© TencentCloudBase, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in skills/doc-freshness-review of TencentCloudBase/CloudBase-AI-Toolkit.

  • SKILL.md
  • references/review-scope.md

Open the folder on GitHubat commit 21af91c

Compare with similar skills

Doc Freshness Review 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.

Doc Freshness Review compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Doc Freshness Review this skillTencentCloudBase/CloudBase-AI-Toolkit1.1k—~1.1kAutomated safety check: PassMIT
Typescript Styletjx666/vscode-mcp106—~961Automated safety check: PassCustom licence
Source Command Unifi MCP Update Docsenuno/unifi-mcp-server282—~899Automated safety check: PassApache-2.0
Githits MCPgithits-com/githits-cli114—~2kAutomated safety check: PassApache-2.0
Library Documentation Seekerwithkynam/vibecode-pro-max-kit1.1k2 repos~1kAutomated safety check: NotesMIT
Dashclaw Shipucsandman/DashClaw310—~7.2kAutomated safety check: PassMIT

Similar skills

  • Typescript Style

    tjx666/vscode-mcp

    TypeScript code style and repo conventions for VSCode MCP — inference vs explicit types, ESM import suffixes, zod schema contracts, async VSCode/Node APIs, JSON-safe IPC results, JSDoc for public…

    106 GitHub stars~961 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Auto-generate and update API.md documentation from tool docstrings

    282 GitHub stars~899 tokensUpdated today
    DevelopmentAuto-check passed
  • Githits MCP

    githits-com/githits-cli

    Route public OSS code, documentation, examples, and package questions to GitHits tools.

    114 GitHub stars~2k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Library Documentation Seeker

    withkynam/vibecode-pro-max-kit

    Looks up library and framework documentation through Context7 first, with bundled Node scripts as a fallback that fetch and analyze llms.txt files.

    1.1k GitHub starsUsed in 2 repos~1k tokens
    DevelopmentAuto-check: notes
  • Dashclaw Ship

    ucsandman/DashClaw

    The single command that gets a DashClaw change ON MAIN AND LIVE — it resolves everything blocking production, never defers, and never hands back a checklist.

    310 GitHub stars~7.2k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Score Harness

    ruvnet/metaharness

    5-dimension scorecard (0-100, grade A/B/C/F) for a scaffolded harness.

    690 GitHub stars~613 tokensUpdated yesterday
    DevelopmentAuto-check passed

More from TencentCloudBase/CloudBase-AI-Toolkit

All 49 skills in this repo
  • AI Model Nodejs

    TencentCloudBase/CloudBase-AI-Toolkit

    A skill your agent uses for Node.js backend AI via @cloudbase/node-sdk (=3.16.0) — cloud functions, CloudRun, Express/Koa/NestJS, serverless APIs, scheduled jobs, LLM proxies, agent orchestration.

    1.1k GitHub starsUsed in 3 repos~5k tokens
    Auto-check passed
  • HTTP API Cloudbase

    TencentCloudBase/CloudBase-AI-Toolkit

    CloudBase official HTTP API client guide. An agent skill from TencentCloudBase/CloudBase-AI-Toolkit.

    1.1k GitHub starsUsed in 3 repos~2.1k tokens
    Auto-check passed
  • Cloud API Recipe Authoring

    TencentCloudBase/CloudBase-AI-Toolkit

    Author or revise a cloud-api-operations recipe (config/source/skills/cloud-api-operations/references/recipes/).

    1.1k GitHub stars~3.7k tokensUpdated yesterday
    Auto-check passed
  • Manage Local Skills

    TencentCloudBase/CloudBase-AI-Toolkit

    Analyze, standardize, validate, and sync locally maintained skills into agent skill directories with a skills CLI-aligned workflow.

    1.1k GitHub stars~1.2k tokensUpdated yesterday
    Auto-check passed
  • Cloudbase Agent Python

    TencentCloudBase/CloudBase-AI-Toolkit

    Build production-ready AI agent backends using the CloudBase Agent Python SDK — create agents with LangGraph/CrewAI/LlamaIndex, serve them via FastAPI with AG-UI protocol streaming +…

    1.1k GitHub starsUsed in 2 repos~2.9k tokens
    Auto-check: notes
  • Cloudbase

    TencentCloudBase/CloudBase-AI-Toolkit

    A skill your agent uses when you develop, design, build, deploy, debug, migrate, or troubleshoot CloudBase (腾讯云开发, 云开发, TCB, 微信云开发) projects — Web, 微信小程序, 小程序, uni-app, mobile (iOS, Android…

    1.1k GitHub starsUsed in 1 repo~4.7k tokens
    Auto-check passed

Questions about Doc Freshness Review

What does Doc Freshness Review do?

A skill your agent uses when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under doc/ and key entry…. Doc Freshness Review is an agent skill from TencentCloudBase/CloudBase-AI-Toolkit.md during periodic maintenance or before preparing corrective PRs.

When should I use Doc Freshness Review?

Doc Freshness Review fits situations like: auditing repository documentation for drift; stale statements; broken references; README mismatches.

How do I install Doc Freshness Review in Claude Code?

Run `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review -a claude-code`. Or copy the skill folder (skills/doc-freshness-review in TencentCloudBase/CloudBase-AI-Toolkit) into .claude/skills/doc-freshness-review in your project. Claude Code loads it when a task matches its description.

How do I install Doc Freshness Review in Codex?

Run `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review -a codex`. Or copy the skill folder (skills/doc-freshness-review in TencentCloudBase/CloudBase-AI-Toolkit) into .agents/skills/doc-freshness-review in your project. Codex loads it when a task matches its description.

Can I use Doc Freshness Review 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 TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-freshness-review, .gemini/skills/doc-freshness-review, .github/skills/doc-freshness-review and .opencode/skills/doc-freshness-review in your project.

What does Doc Freshness Review need to run?

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

Does Doc Freshness Review 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 Doc Freshness Review 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 Doc Freshness Review use?

Doc Freshness Review is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Doc Freshness Review use?

About 1.1k tokens (SKILL.md is roughly 4.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 310 tokens, read only when the agent opens those files.

What are the alternatives to Doc Freshness Review?

Skills that share tags, products or a category with Doc Freshness Review: Typescript Style (tjx666/vscode-mcp, 106 stars), Source Command Unifi MCP Update Docs (enuno/unifi-mcp-server, 282 stars), Githits MCP (githits-com/githits-cli, 114 stars) and Library Documentation Seeker (withkynam/vibecode-pro-max-kit, 1.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Doc Freshness Review?

TencentCloudBase (a GitHub organization) maintains it in TencentCloudBase/CloudBase-AI-Toolkit, which has 1,133 GitHub stars. The repository holds 49 skills in this directory. The repository was last updated on October 7, 2026.

Source: TencentCloudBase/CloudBase-AI-Toolkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.