doc-tests

A checker that reviews test files for documentation explaining what they test, why it matters, which code they cover, and how each test is structured. Test intent describes the behavior or risk a test protects.

In plain words
What is it for?
Use it to check test-suite headers, story or feature references, risk explanations, application layers, source-file paths, behavior-based names, and GIVEN/WHEN/THEN or Arrange/Act/Assert comments.
Why use it?
It makes tests easier to understand, maintain, and safely remove when their purpose is no longer clear.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/samibs/skillfoundry/doc-tests
Any agent
npx skills add samibs/skillfoundry --skill doc-tests
Clone the repo
git clone --depth 1 https://github.com/samibs/skillfoundry

Made for: Claude Code, Codex.

Per session 6 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 657 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00006 $0.00657
Opus 5 $0.00003 $0.00329
Sonnet 5 $0.00001 $0.00131
Haiku 4.5 $0.00001 $0.00066

Measured 2d ago against content hash f01f0e06564c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

doc-tests 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 2d ago.

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.

.agents/skills/doc-tests/SKILL.md · 87 lines

How it starts

The opening of the file, as written. The whole thing — 87 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Test Documentation Checker

You are the Test Documentation Checker — a static analysis agent that verifies test files include proper intent documentation. Tests without documented intent become unmaintainable: nobody knows why they exist, what they protect, or whether they can be safely removed.


What You Check

1. File-Level: @test-suite Header

Every test file must start with a documentation block containing:

Field Required What to Look For
@test-suite Yes Name of the module/feature under test
@story Yes Reference to STORY-XXX or feature being tested
@rationale Yes 1-2 sentences: what risk does this suite mitigate?
@layer Yes database, backend, frontend, integration, or e2e
@file-under-test Yes Path to the source file being tested

2. Test-Level: Structure Comments

Every individual test must contain:

Element Required What to Look For
GIVEN/WHEN/THEN Yes Or Arrange/Act/Assert section markers in comments
WHY comment Yes Explains what contract or invariant the test enforces
Behavior-driven name Yes Test name reads as a sentence describing behavior and outcome

3. WHY Comment Quality

A WHY comment PASSES if it:

  • Explains what breaks if this test is removed
  • References a specific risk, bug, requirement, or contract
  • Connects the test to a business or technical invariant

A WHY comment FAILS if it:

  • Restates the test name ("WHY: tests the login function")
  • Is generic ("WHY: for coverage")
  • Is missing entirely

Output Format

DOC-TEST CHECK: [test file]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━

FILE HEADER:
  @test-suite:       [PRESENT / MISSING]
  @story:            [PRESENT / MISSING]
  @rationale:        [PRESENT / MISSING]
  @layer:            [PRESENT / MISSING]
  @file-under-test:  [PRESENT / MISSING]

TEST CASES:
  PASS  test_login_with_expired_token_returns_401
         → WHY: present, GIVEN/WHEN/THEN: present

  FAIL  test_update_user
         → WHY: missing
         → GIVEN/WHEN/THEN: missing
         → Name is not behavior-driven (what outcome?)

━━━━━━━━━━━━━━━━━━━━━━━━━━━━
RESULT: [X/Y checks passed] — [COMPLIANT / NEEDS DOCUMENTATION]

Read the full file on GitHub · 87 lines

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.

  1. 2d ago First seen · 87 lines · 6 tokens per session scan A f01f0e06564c

Subscribe to this mod's changes

doc-tests is a skill published in the GitHub repository samibs/skillfoundry (12 stars, last pushed 1mo ago), licensed MIT. It adds 6 tokens to every session and 657 once invoked, about $0.0000 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-30.

Related

Other skills, from other repositories

memorix-sessions

Use when resuming work, preparing handoff context, binding an HTTP control-plane project, or deciding whether sessionstart is useful.

AVIDS2/memorix · 31 tokens

memorix-troubleshooting

Use when Memorix MCP, setup, project binding, HTTP control plane, hooks, skills, or agent integration is missing, stale, or failing.

AVIDS2/memorix · 36 tokens

ring:applying-composition-patterns

React composition patterns that scale. Avoid boolean prop proliferation by using compound components, lifting state, and composing internals. Use when refactoring components with boolean prop proliferation, building flexible component libraries, or during architecture review. Skip for simple components with 1-2 props…

LerianStudio/ring · 68 tokens

ring:searching-code

Forensic code search and analysis with optional Chain of Draft (CoD) ultra-concise mode. Five-phase methodology (clarification, planning, execution, analysis, synthesis) with severity assessment. Use for targeted investigation of specific patterns, bugs, or vulnerabilities. Skip for broad architecture mapping (use…

LerianStudio/ring · 74 tokens

ring:exploring-codebases

Exploring a codebase across phases: scopes the target, detects architecture, components, and layers, deep-dives each discovered perspective, then synthesizes findings into actionable guidance with file:line evidence. Use to understand how a feature or system works before planning changes, or to orient on an unfamiliar…

LerianStudio/ring · 91 tokens

ring:auditing-dependency-security

Auditing a dependency for supply-chain risk before install (pip/npm/go/cargo): checks typosquatting, maintainer/age risk, vulnerability DBs (OSV, GHSA, Socket), and lockfile hash pinning, then emits a risk score and approve/conditional/escalate/block decision. Use when adding or updating a dependency, reviewing a…

LerianStudio/ring · 102 tokens