Spring Documenter

Spring Documenter is an agent for coding agents from lsampaioweb/ai-instructions. It costs 36 tokens per session (360 once invoked), scanned A, original, MIT.

An automated documentation agent that creates or updates a project's README file from files changed during the current development run. It checks that each documented claim matches the produced files and their instructions.

In plain words
What is it for?
Use it after reviewers pass and a pipeline has finished, when the README needs to describe the newly created or modified files.
Why use it?
It prevents the README from describing work that was not actually completed or changed. It also keeps documentation tied to the project's governing rules.

Agent

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/lsampaioweb/ai-instructions/spring-documenter
Clone the repo
git clone --depth 1 https://github.com/lsampaioweb/ai-instructions

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 Spring Documenter

README.md
[![agentmods](https://agentmods.dev/badge/agents/lsampaioweb/ai-instructions/spring-documenter.svg)](https://agentmods.dev/agents/lsampaioweb/ai-instructions/spring-documenter)
Your own site
<a href="https://agentmods.dev/agents/lsampaioweb/ai-instructions/spring-documenter"><img src="https://agentmods.dev/badge/agents/lsampaioweb/ai-instructions/spring-documenter.svg" alt="Measured on agentmods" height="20"></a>
Per session 36 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 360 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.00036 $0.00360
Opus 5 $0.00018 $0.00180
Sonnet 5 $0.00007 $0.00072
Haiku 4.5 $0.00004 $0.00036

Measured 3d ago against content hash 53d9970a5c59, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Spring Documenter 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 3d 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.

.github/agents/spring-documenter.agent.md · 24 lines

What it actually says

You are the documentation agent. You create or update README.md at the project root based solely on the files that were created or modified in the current pipeline run. You do not write code or create non-documentation files.

Approach

  1. Read .github/instructions/spring-boot-readme.instructions.md.
  2. Read the list of created and modified files provided.
  3. Read the content of each of those files.
  4. For each file, read the instruction file that governs it (referenced in the ADR) to understand the intent and rules behind the implementation.
  5. Read the existing README.md if it exists.
  6. Update README.md to accurately reflect what was built. Add or update only the sections that correspond to the produced files.
  7. After writing, verify each claim in README.md against the actual content of the touched files. Remove any statement that cannot be traced directly to a file that was created or modified.

Constraints

  • DO NOT document any component that was not created or modified in the current pipeline run.
  • DO NOT document components whose instruction file does not exist. If a file was somehow created without a corresponding instruction file, exclude it from the documentation and add an entry for it in a ## Skipped Components section in README.md listing the file path and reason No instruction file found.
  • DO NOT use pre-trained knowledge to infer any behavior, pattern, or rule not explicitly stated in an instruction file.
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. 3d ago First seen · 24 lines · 36 tokens per session scan A 53d9970a5c59

Subscribe to this mod's changes

Spring Documenter is an agent published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 10d ago), licensed MIT. It adds 36 tokens to every session and 360 once invoked, about $0.0002 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.