What is docs-parity-reviewer?

A documentation review skill for changes in pydantic-ai-harness. It checks that the capability's README, unified documentation page, code, examples, and links agree.

Use it as a final documentation check for a capability change or pull request in the pydantic-ai-harness project.

User-facing documentation can become outdated when code changes or when one documentation page is edited without the other. The review catches mismatched pages and snippets that do not run before a pull request merges.

How pydantic/pydantic-ai configures Claude Code

About the project

Pydantic AI is a typed Python SDK for building AI agents that can use different language models and interfaces, including voice, image generation, and embeddings. Developers use it for applications ranging from structured data extraction to long-running multi-agent work. The catalogue entries provide workflows and configuration for its coding-agent and harness features.

pydantic/pydantic-ai · 20,771 stars · on GitHub · pydantic.dev

Reuse

Borrowing it

Nothing to install: this file belongs to pydantic/pydantic-ai. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/pydantic/pydantic-ai/main/.agents/skills/docs-parity-reviewer/SKILL.md

Clone the repo

git clone --depth 1 https://github.com/pydantic/pydantic-ai

Made for: Claude Code.

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/pydantic/pydantic-ai/docs-parity-reviewer/github.svg)](https://agentmods.dev/skills/pydantic/pydantic-ai/docs-parity-reviewer)

Your own site

<a href="https://agentmods.dev/skills/pydantic/pydantic-ai/docs-parity-reviewer"><img src="https://agentmods.dev/badge/skills/pydantic/pydantic-ai/docs-parity-reviewer/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/pydantic/pydantic-ai/docs-parity-reviewer"><img src="https://agentmods.dev/badge/skills/pydantic/pydantic-ai/docs-parity-reviewer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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

When invoked 1,346 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.00106	$0.01346
Opus 5.5	$0.00042	$0.00538
Sonnet 5.5	$0.00021	$0.00269
Haiku 4.5	$0.00011	$0.00135

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

Security

Grade A, and why

docs-parity-reviewer 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 19d 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/docs-parity-reviewer/SKILL.md · 90 lines

How it starts

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

You are the documentation parity gate for pydantic-ai-harness. Every released capability ships two docs that must stay in sync with the code and with each other:

README -- src/pydantic_ai_harness/pydantic_ai_harness/<capability>/README.md (or src/pydantic_ai_harness/pydantic_ai_harness/experimental/acp/README.md for ACP). Serves GitHub and PyPI. Keeps absolute links and its badges.
Unified doc -- flat at docs/harness/<capability>.md. Renders on the docs site (https://pydantic.dev/docs/ai/harness/). No badges; links its source module and, where the capability exposes a public class, may end with ::: pydantic_ai_harness.<Class> autodoc blocks. The docs/harness/ folder is flat -- no capabilities/ or experimental/ subdirectories.

Both are hand-maintained. A change to one that is not reflected in the other is the failure mode you exist to catch.

What you are given

The diff or description of a capability change (the touched capability, and what its user-facing behavior now is). If you are not told which capability changed, infer it from the files the current branch changes under src/pydantic_ai_harness/pydantic_ai_harness/ and docs/harness/.

Checks

Read the capability source, its README, and its unified doc, then report each problem as a finding (blocking / warning / nit) with a concrete fix.

Both docs updated. If the change alters user-facing behavior (public class, constructor params, defaults, tool names, extras, safety semantics) and only one of README / unified doc reflects it, that is blocking. A doc describing behavior the code no longer has is also blocking.
Snippets parse and run. Run uv run pytest tests/harness/test_doc_snippets.py; this checks parsing and harness imports only. Execute every changed deterministic snippet unchanged. For snippets that need credentials or a live service, verify the complete runnable wrapper and require a fake-backed test for its control flow. Every block has all imports and capability wiring. Class names, params, and defaults match the source. Model ids are unchanged -- a changed model id is blocking. Illustrative signature pseudo-code uses {test="skip"}.
README <-> unified doc consistency. The two agree on install extras, option names, defaults, and safety caveats. They need not be identical prose, but they must not contradict each other or the code.
Links. Unified doc: harness-internal links are relative .md ([Shell](shell.md)); other Pydantic AI pages are relative .md links from docs/harness/ ([Toolsets](../toolsets.md)), and API elements use reference-style links ([RunContext][pydantic_ai.tools.RunContext]). No root-relative /ai/... paths or legacy ai.pydantic.dev links, no leftover ../../README.md, and no badge markup. README: absolute links are fine.
Source link + API block. Every page links its source module (https://github.com/pydantic/pydantic-ai/tree/main/src/pydantic_ai_harness/pydantic_ai_harness/<module>/) so a reading agent can verify behavior -- a missing source link is a finding. Where the capability exposes a public class, the page may also end with a ## API reference section of ::: pydantic_ai_harness... autodoc blocks (auto-expanded from the docstring, not hand-written). If a class docstring is too thin to render a useful API section, flag it -- the fix is a richer docstring, not a hand-written table.
Safety caveats preserved. Where the source carries access, sandbox, or command-control limits (Shell, CodeMode, FileSystem), both docs state them.
Writing style. Both follow src/pydantic_ai_harness/AGENTS.md "Writing style": no em-dashes (use --), no hype, plain ASCII punctuation.
Purpose-first lead. The opening paragraph of both docs states what the capability is for and when to use it. An internal hook or class name (before_model_request, after_tool_execute, ...) in the first paragraph, ahead of the purpose, is a finding -- move the mechanism lower.
Name matches the capability. The doc filename, its # H1, and the README # H1 all use the capability's descriptive name (e.g. "Overflowing Tool Output", not "Overflow"). A short or ClassName-style heading is a finding.
Stability framing. Graduated capabilities carry the soft "The API may change between releases..." note mirrored from the README, not a HarnessExperimentalWarning block or "removed in any release" wording. ACP is the only page that keeps an !!! warning "Experimental".

Read the full file on GitHub · 90 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.

19d ago First seen · 90 lines · 106 tokens per session scan A e4daa6f4f0ae

Subscribe to this mod's changes

docs-parity-reviewer is a skill published in the GitHub repository pydantic/pydantic-ai (20,771 stars, last pushed today), licensed MIT. It adds 106 tokens to every session and 1,346 once invoked, about $0.0004 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-10-03.

LLM Python Writing and docs agent-framework genai harness pydantic

pydantic-ai: Skill for Claude Code

Borrowing it

Wrote this? Show the measurements

What it costs to keep this loaded

Grade A, and why

Nothing flagged

How it starts

What you are given

Checks

What this file has done since we first saw it

Other skills, from other repositories

data-analysis

diagram-design

systematic-debugging

verification-strategy

data-formats

research-methodology