docvet AGENTS.md

docvet AGENTS.md is an instructions file for Codex, OpenCode from Alberto-Codes/docvet. It costs 760 tokens per session, scanned A, original, MIT.

A set of project instructions for docvet, a Python tool that checks code documentation strings for presence, completeness, accuracy, and renderability.

In plain words
What is it for?
Use it to understand docvet's checks, install it, run it on changed or staged files, and configure the project.
Why use it?
It gives developers a shared reference for the tool's quality checks, installation, configuration, and commands.

Instructions file for CodexOpenCode

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 instructions/alberto-codes/docvet/agents-md
Clone the repo
git clone --depth 1 https://github.com/Alberto-Codes/docvet

Made for: Codex, OpenCode.

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.

agentmods badge for docvet AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/alberto-codes/docvet/agents-md.svg)](https://agentmods.dev/instructions/alberto-codes/docvet/agents-md)
Your own site
<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="Measured on agentmods" height="20"></a>
Per session 760 This file is loaded in full into every session.
When invoked 760 The same file — it is already loaded in full.
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.00760 $0.00760
Opus 5 $0.00380 $0.00380
Sonnet 5 $0.00152 $0.00152
Haiku 4.5 $0.00076 $0.00076

Measured yesterday against content hash 95a0f2dec1ce, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

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

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.md · 78 lines

How it starts

The opening of the file, as written. The whole thing — 78 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 whether docstrings are present, complete, accurate, and renderable. 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 Raises, Yields, Attributes, Examples, and 6 more sections
4. Accuracy freshness Docstrings that fell out of sync with code (git diff + blame)
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 Detect 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.

What Each Check Does

  • enrichment -- Flags functions, classes, and modules missing required docstring sections (Raises, Yields, Receives, Warns, Attributes, Examples, cross-references, and more). 10 rules.
  • freshness -- Detects docstrings that no longer match the code, using git diff (immediate) and git blame (drift over time). 5 rules.
  • coverage -- Finds package directories without __init__.py, which makes them invisible to mkdocs. 1 rule.
  • griffe -- Captures griffe parser warnings that would break mkdocs rendering. 3 rules.

Read the full file on GitHub · 78 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. yesterday First seen · 78 lines · 760 tokens per session scan A 95a0f2dec1ce

Subscribe to this mod's changes

docvet AGENTS.md is an instructions file published in the GitHub repository Alberto-Codes/docvet (9 stars, last pushed 2d ago), licensed MIT. It adds 760 tokens to every session, about $0.0038 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-09-03.