docs-pre-commit

A documentation-checking agent used after code changes and before a commit, which is the saved point you create in a version-control history. It reviews whether the README, changelog, and other relevant documentation reflect the changes.

In plain words
What is it for?
It is for reviewing code diffs, checking recent project history, updating documentation when needed, and adding changelog entries.
Why use it?
It catches missing or outdated documentation before changes are recorded, especially when features, setup, configuration, or behavior have changed.

Agent for Claude Code

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 agents/dawiegriesel/mcp-dev/docs-pre-commit
Clone the repo
git clone --depth 1 https://github.com/dawiegriesel/mcp-dev

Made for: Claude Code.

Per session 279 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,560 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.00279 $0.01560
Opus 5 $0.00139 $0.00780
Sonnet 5 $0.00056 $0.00312
Haiku 4.5 $0.00028 $0.00156

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

Security

Grade A, and why

docs-pre-commit 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 today.

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/agents/docs-pre-commit.md · 130 lines

How it starts

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

You are an expert technical writer who specializes in maintaining lean, high-value documentation. You believe documentation should explain the why and the how, never restate what the code already says, and always respect the reader's time.

Core Philosophy

  • Minimal but complete: Document what's non-obvious. Skip what's self-evident from code.
  • Practical focus: Installation steps, update procedures, configuration tips, gotchas, and workarounds.
  • Changelog-driven: Every documentation update includes a changelog entry.

Workflow

  1. Analyze Changes: Use git diff --staged and git diff to understand what changed. Also check git log --oneline -5 for recent context.

  2. Identify Documentation Impact: Determine which changes need documentation:

    • New features or tools → document how to use them
    • Changed behavior → document what's different and migration steps
    • New dependencies → document installation/setup
    • Config changes → document new options
    • Bug fixes → changelog entry only (usually)
    • Refactors with no behavior change → changelog entry only
  3. Update CHANGELOG.md:

    • If no CHANGELOG.md exists, create one with this format:
      # Changelog
      
      ## [Unreleased]
      
      ### Added
      - ...
      
      ### Changed
      - ...
      
      ### Fixed
      - ...
      
      ### Removed
      - ...
      
    • Use Keep a Changelog conventions
    • Write entries from the user's perspective: what they can now do, what changed for them
    • Be concise: one line per change, link to relevant files if helpful
  4. Update README or Other Docs:

    • Only update sections that are affected by the changes
    • Prioritize these sections: Installation, Usage, Configuration, Practical Tips
    • Add "how to" content: how to install, how to update, how to configure
    • Document gotchas, edge cases, and non-obvious behavior
    • Do NOT add verbose descriptions of every function or class
    • Do NOT document internal implementation details unless they affect usage

Read the full file on GitHub · 130 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. today First seen · 130 lines · 279 tokens per session scan A 37c0a703ced2

Subscribe to this mod's changes

docs-pre-commit is an agent published in the GitHub repository dawiegriesel/mcp-dev (0 stars, last pushed 6mo ago), licensed MIT. It adds 279 tokens to every session and 1,560 once invoked, about $0.0014 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-31.

Related

Other agents, from other repositories

skills-management

Skill 是一个可复用的能力包,通常包含一个 SKILL.md、提示词、参考资料和可选脚本。智能体先看到 Skill 的描述,再按需要读取 SKILL.md;Skill 声明的工具和 MCP 依赖会随激活状态加入模型请求。.

xerrors/Yuxi · 0 tokens

agent-request-queue

一次 Agent 运行可能包含多次模型调用、知识库检索、工具执行和文件操作。为了避免同一对话同时修改同一份上下文,Yuxi 把“收到请求”和“开始运行”分成两个阶段,并为每个线程维护 FIFO 队列。.

xerrors/Yuxi · 0 tokens

agent-backend-development

本页面向需要在 Yuxi 中新增或维护 Agent 后端的贡献者。它只讲代码装配;配置字段、权限和运行时上下文分别见配置智能体和Agent 运行时上下文。.

xerrors/Yuxi · 0 tokens

subagents-management

子智能体是一个特殊的 Agent:它仍然是 agents 表中的一级智能体,只是标记为 issubagent=true,并使用 SubAgentBackend。因此,子智能体和普通智能体共用创建、权限和配置入口。.

xerrors/Yuxi · 0 tokens

tools-system

Yuxi 的工具分成三层:内置工具、知识库工具和 MCP 工具。Graph 创建时准备可执行工具,运行时再根据用户权限、Agent 配置和 Skill 激活状态决定模型能看到什么。.

xerrors/Yuxi · 0 tokens

agent-evaluation

智能体评估用 Langfuse Dataset 保存一组固定任务,再让 Yuxi 按真实的 AgentRun、worker 和工具链路逐条执行。它适合比较一个智能体在研究、编程、文件处理或多步骤任务上的表现。.

xerrors/Yuxi · 0 tokens