readme-agents

readme-agents is a skill for Claude Code, Codex from fmind/dot. It costs 43 tokens per session (468 once invoked), scanned A, original, MIT.

A documentation-maintenance workflow that keeps AGENTS.md for coding agents and README.md for people aligned with the current codebase. It checks the repository structure, tools, commands, and usage instructions.

In plain words
What is it for?
Use it to update project commands, prerequisites, layout descriptions, installation steps, and usage examples.
Why use it?
It removes stale or conflicting documentation after the project changes. It also separates technical instructions for agents from setup and usage information for humans.

Skill for Claude CodeCodex

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 skills/fmind/dot/readme-agents
Any agent
npx skills add fmind/dot --skill readme-agents
Clone the repo
git clone --depth 1 https://github.com/fmind/dot

Made for: Claude Code, Codex.

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 readme-agents

README.md
[![agentmods](https://agentmods.dev/badge/skills/fmind/dot/readme-agents.svg)](https://agentmods.dev/skills/fmind/dot/readme-agents)
Your own site
<a href="https://agentmods.dev/skills/fmind/dot/readme-agents"><img src="https://agentmods.dev/badge/skills/fmind/dot/readme-agents.svg" alt="Measured on agentmods" height="20"></a>
Per session 43 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 468 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.00043 $0.00468
Opus 5 $0.00022 $0.00234
Sonnet 5 $0.00009 $0.00094
Haiku 4.5 $0.00004 $0.00047

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

Security

Grade A, and why

readme-agents 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.

skills/readme-agents/SKILL.md · 32 lines

What it actually says

Sync README and AGENTS Files

Refresh AGENTS.md (tooling, commands, conventions, and layout for agents) and README.md (purpose, installation, and usage for humans) so both reflect the repository's current state. improve-docs owns the wider documentation set.

Workflow

  1. Research: scan the root directory and key config files (pyproject.toml, go.mod, mise.toml, lefthook.yml) to identify tools and structure.
  2. Update AGENTS.md: refresh the tool list and commands, and update the Layout section (a bullet list of top-level files and directories with a one-sentence purpose each).
  3. Update README.md: make purpose, prerequisites, and usage examples current and remove stale instructions.
  4. Validate: run lychee README.md AGENTS.md so refreshed links are proven live, not assumed.

Gotchas

  • Separation of concerns: user-facing installation instructions belong in README.md; technical conventions and rules belong in AGENTS.md.
  • Workflows become skills: a multi-step section that outgrows AGENTS.md moves to a skill per skillify, leaving a one-line pointer.

Documentation

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 · 32 lines · 43 tokens per session scan A fdbde2fa4bd7

Subscribe to this mod's changes

readme-agents is a skill published in the GitHub repository fmind/dot (4 stars, last pushed today), licensed MIT. It adds 43 tokens to every session and 468 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-09-03.