What is doc-smith-check?

An internal checker for Doc-Smith workspaces, validating document structure, metadata, generated HTML, navigation, links, and images.

Use it to check the whole workspace or validate only its structure, content, or selected document paths.

It detects missing files, invalid paths, broken links, and other content or structure problems in generated documentation.

doc-smith-check — Skill for Claude Code by AIGNE-io

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent

npx skills add AIGNE-io/doc-smith-skills --skill doc-smith-check

Clone the repo

git clone --depth 1 https://github.com/AIGNE-io/doc-smith-skills

Made for: Claude Code.

Or install doc-smith, the plugin that ships this one along with the rest of its 6 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/skills/aigne-io/doc-smith-skills/doc-smith-check/github.svg)](https://agentmods.dev/skills/aigne-io/doc-smith-skills/doc-smith-check)

Your own site

<a href="https://agentmods.dev/skills/aigne-io/doc-smith-skills/doc-smith-check"><img src="https://agentmods.dev/badge/skills/aigne-io/doc-smith-skills/doc-smith-check/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/skills/aigne-io/doc-smith-skills/doc-smith-check"><img src="https://agentmods.dev/badge/skills/aigne-io/doc-smith-skills/doc-smith-check.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 35 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 731 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00035	$0.00731
Opus 5	$0.00017	$0.00365
Sonnet 5	$0.00007	$0.00146
Haiku 4.5	$0.00003	$0.00073

Measured 10d ago against content hash 174f43658e50, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

doc-smith-check scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

The scan reads SKILL.md. This mod also ships 6 executable files (scripts/check-content.mjs, scripts/check-structure.mjs, scripts/clean-invalid-docs.mjs, …), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/doc-smith-check/SKILL.md · 75 lines

What it actually says

Doc-Smith 文档检查

校验 Doc-Smith workspace 的结构和内容完整性。

用法

/doc-smith-check                              # 全部检查（结构 + 内容）
/doc-smith-check --structure                  # 只检查结构
/doc-smith-check --content                    # 只检查内容
/doc-smith-check --content --path /api/auth   # 检查指定文档

选项

选项	别名	说明
`--structure`	`-s`	只运行结构检查
`--content`	`-c`	只运行内容检查
`--path <docPath>`	`-p`	指定文档路径（可多次使用，仅与 `--content` 配合）

校验规则

结构校验 (--structure)

执行脚本：node skills/doc-smith-check/scripts/check-structure.mjs

校验 planning/document-structure.yaml：

YAML 语法正确
每个文档有 title、path、description
path 以 / 开头
sourcePaths 格式正确
可自动修复的格式错误会自动修复并提示重新读取

内容校验 (--content)

执行脚本：node skills/doc-smith-check/scripts/check-content.mjs [--path <p>]

校验 dist/ 中的 HTML 和 docs/ 中的元数据：

校验项	说明
HTML 文件存在	`dist/{lang}/docs/{path}.html`
.meta.yaml 存在	`docs/{path}/.meta.yaml`，含 kind/source/default
nav.js 存在	`dist/assets/nav.js`
内部链接有效	链接目标文档存在，无 `.md` 后缀
图片可访问	本地图片文件存在，远程图片可达
路径格式	MD 源文件应使用 `/assets/` 格式，`../../assets/` 旧格式产生警告

路径格式校验

内容校验自动包含路径格式检查：

若 docs/{path}/ 下存在 .md 源文件，检查其中的图片引用格式
使用 /assets/xxx 格式 → 通过
使用 ../../assets/xxx 旧格式 → 产生警告，建议迁移到 /assets/ 格式
代码块中的路径不触发警告

错误处理

结构检查失败：根据错误信息修正 document-structure.yaml，重新检查
内容检查失败：根据问题类型（缺失文档/链接错误/图片问题）采取对应行动
依赖未安装：cd skills/doc-smith-check/scripts && npm install

被其他 Skill 调用

生成 document-structure.yaml 后：/doc-smith-check --structure
生成文档内容后：/doc-smith-check --content
结束前最终校验：/doc-smith-check

Files

What ships with it

8 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

10d ago First seen · 75 lines · 35 tokens per session scan A 174f43658e50

Subscribe to this mod's changes

doc-smith-check is a skill published in the GitHub repository AIGNE-io/doc-smith-skills (9 stars, last pushed 5mo ago), licensed Apache-2.0. It adds 35 tokens to every session and 731 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Documents Testing

pptx-html-fidelity-audit

Audit a python-pptx export against its source HTML deck, identify layout/content drift (footer overflow, cropped content, missing italic/em, lost styling, off-rhythm spacing), and re-export with strict footer-rail + cursor-flow layout discipline. Use this skill whenever the user has a .pptx that was generated from an…

nexu-io/open-design · 185 tokens

foundry-hosted-agent-validation

Step-by-step process for validating a Python Foundry hosted agent sample (under python/samples/04-hosting/foundry-hosted-agents/) end to end — running it locally (native runtime and azd ai agent run) and after deploying it to an Azure AI Foundry project with azd. Use this when asked to validate a hosted agent sample.

microsoft/agent-framework · 82 tokens

typescript-providers

Implement, modify, test, or document TypeScript provider packages under ts/packages/providers, including framework adapters for OpenAI, Anthropic, Google, LangChain, Mastra, Vercel, LlamaIndex, Cloudflare, and Claude Agent SDK. Use for provider-specific TS work; do not use for core-only changes.

ComposioHQ/composio · 70 tokens

doc-smith-check