docvet CLAUDE.md

docvet CLAUDE.md is an instructions file for coding agents from Alberto-Codes/docvet. It costs 1,750 tokens per session, scanned A, original, MIT.

A set of project instructions for docvet, a Python command-line tool that checks whether documentation strings in code are present, complete, accurate, and render correctly.

In plain words
What is it for?
Use it to install, configure, lint, type-check, test, and run docvet checks in a Python project.
Why use it?
It helps catch missing or outdated code documentation and problems that could break generated documentation sites.

Instructions file

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

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 CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/alberto-codes/docvet/claude-md.svg)](https://agentmods.dev/instructions/alberto-codes/docvet/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/alberto-codes/docvet/claude-md"><img src="https://agentmods.dev/badge/instructions/alberto-codes/docvet/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,750 This file is loaded in full into every session.
When invoked 1,750 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.01750 $0.01750
Opus 5 $0.00875 $0.00875
Sonnet 5 $0.00350 $0.00350
Haiku 4.5 $0.00175 $0.00175

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

Security

Grade A, and why

docvet CLAUDE.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.

CLAUDE.md · 144 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

docvet is a Python 3.12+ CLI tool for comprehensive docstring quality vetting. It goes beyond style linting (ruff D rules) by verifying docstrings are present, complete, accurate, and renderable for mkdocs-material + mkdocstrings workflows. Targets PyPI publication as docvet.

Build & Development

Build system: uv_build (PEP 517/518). Entry point: docvet = "docvet:main" in src/docvet/__init__.py. Published to PyPI as docvet v1.0.0.

# Install in development mode
uv sync

# With optional griffe support
uv sync --extra griffe

# With dev tools (pytest, ruff, ty)
uv sync --dev

# Run the CLI
docvet check

Commands

# Linting & formatting
uv run ruff check .            # Lint
uv run ruff check --fix .      # Lint with auto-fix
uv run ruff format .           # Format

# Type checking
uv run ty check

# Tests
uv run pytest                  # All tests
uv run pytest tests/unit       # Unit tests only (by directory)
uv run pytest -m unit           # Unit tests only (by marker)
uv run pytest -m integration    # Integration tests only (by marker)
uv run pytest -k test_name     # Single test by name
uv run pytest -m "not slow"    # Skip slow tests
uv run pytest --cov=docvet --cov-report=term-missing  # With coverage

# CLI (installed as `docvet` console script)
docvet check                   # Run all checks on git diff files
docvet check --staged          # Run checks on staged files
docvet check --all             # Run checks on entire codebase
docvet presence                # Run presence check only
docvet enrichment              # Run enrichment check only
docvet freshness               # Run freshness check only
docvet freshness --mode drift  # Run freshness drift sweep via git blame
docvet coverage                # Run coverage check only
docvet griffe                  # Run griffe compatibility check only
docvet fix                     # Scaffold missing docstring sections
docvet fix --dry-run           # Preview scaffolding without writing files
docvet config                  # Show effective configuration
docvet lsp                     # Start LSP server for editor diagnostics
docvet mcp                     # Start MCP server for AI agents

Read the full file on GitHub · 144 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 · 144 lines · 1,750 tokens per session scan A e9d4282bf12c

Subscribe to this mod's changes

docvet CLAUDE.md is an instructions file published in the GitHub repository Alberto-Codes/docvet (9 stars, last pushed yesterday), licensed MIT. It adds 1,750 tokens to every session, about $0.0088 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.