Borrowing it
Nothing to install: this file belongs to Alberto-Codes/docvet. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/Alberto-Codes/docvet/main/AGENTS.mdgit clone --depth 1 https://github.com/Alberto-Codes/docvetWrote 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.
[](https://agentmods.dev/instructions/alberto-codes/docvet/agents-md)<a href="https://agentmods.dev/instructions/alberto-codes/docvet/agents-md"><img src="https://agentmods.dev/badge/instructions/alberto-codes/docvet/agents-md/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.
<a href="https://agentmods.dev/instructions/alberto-codes/docvet/agents-md"><img src="https://agentmods.dev/badge/instructions/alberto-codes/docvet/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.00896 | $0.00896 |
| Opus 5.5 | $0.00358 | $0.00358 |
| Sonnet 5.5 | $0.00179 | $0.00179 |
| Haiku 4.5 | $0.00090 | $0.00090 |
Grade A, and why
docvet AGENTS.md 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 5d 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.
How it starts
The opening of the file, as written. The whole thing — 80 lines — stays where its author put it; the contents beside it link to each section on GitHub.
docvet
docvet is a Python CLI tool that checks docstring presence, structural completeness, potential staleness, and rendering compatibility. It covers layers 1 and 3-6 of its quality model; layer 2 (style) is handled by ruff.
Quality Model
| Layer | Check | What it catches |
|---|---|---|
| 1. Presence | presence |
Public symbols missing docstrings + coverage reporting |
| 3. Completeness | enrichment |
Missing sections, parameter agreement, and other structural checks |
| 4. Accuracy | freshness |
Potentially stale docstrings (git diff + blame heuristics) |
| 5. Rendering | griffe |
Warnings that break mkdocs-material + mkdocstrings output |
| 6. Visibility | coverage |
Packages missing __init__.py (invisible to mkdocs) |
Layer 2 (style) is handled by ruff.
Install
pip install docvet
For griffe rendering checks:
pip install docvet[griffe]
Run
| Command | What it does |
|---|---|
docvet check --all |
Run all checks on entire codebase |
docvet check |
Run all checks on files changed since last commit |
docvet check --staged |
Run checks on staged files only |
docvet enrichment |
Check for missing docstring sections |
docvet freshness |
Flag potentially stale docstrings via git |
docvet coverage |
Find packages invisible to mkdocs |
docvet griffe |
Check mkdocs rendering compatibility |
Use docvet check --all for broad sweeps. Use docvet check or docvet check --staged for incremental workflows.
Configure
Add [tool.docvet] to pyproject.toml:
[tool.docvet]
exclude = ["tests", "scripts"]
fail-on = ["enrichment", "freshness", "coverage", "griffe"]
[tool.docvet.freshness]
drift-threshold = 30
age-threshold = 90
Key options: exclude filters directories, fail-on controls which checks cause a non-zero exit code.
A check in fail-on that cannot run — most often griffe without the docvet[griffe] extra — exits 1 by default. Set fail-on-unavailable = false (or pass --no-fail-on-unavailable) to warn on stderr and exit 0 instead. With --format json, the run object reports status (passed, findings, unavailable, or incomplete), exit_reason, and an unavailable_checks array carrying a remedy for each. Read run.status and run.unavailable_checks rather than inferring completion from an empty findings list.
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.
- 5d ago Changed · +1 tokens per session 3d273e9e4564
- 1mo ago Changed 9e40c5e0ea78
- 1mo ago Changed · +2 lines · +135 tokens per session c5cbd9a0be62
- 1mo ago First seen · 78 lines · 760 tokens per session scan A 95a0f2dec1ce
docvet AGENTS.md is an instructions file published in the GitHub repository Alberto-Codes/docvet (10 stars, last pushed yesterday), licensed MIT. It adds 896 tokens to every session, about $0.0036 per session on Opus 5.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-09-03.
Other instructions, from other repositories
agent-ready copilot-instructions.md
Instructions for vb-nattamai/agent-ready, covering copilot instructions — helloworld, project summary, commands, module layout and restricted paths.
vscode buildNext.instructions.md
Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).
next.js AGENTS.md
AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
langchain AGENTS.md
AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).