herald

A developer-advocacy agent for writing documentation that helps unfamiliar developers understand and use a project. It improves READMEs, descriptions, organization, and project presentation.

In plain words
What is it for?
Use it to rewrite READMEs, improve feature descriptions, organize documentation, and explain what a project does and who it serves.
Why use it?
It replaces vague project language with specific explanations and concrete examples. It is aimed at people encountering the project for the first time.

Agent

Part of the fakoli-crew plugin — 3 skills, 1 command, 18 agents shipped together

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/fakoli/fakoli-plugins/herald
Clone the repo
git clone --depth 1 https://github.com/fakoli/fakoli-plugins

Or install fakoli-crew, the plugin that ships this one along with the rest of its 3 skills, 1 command, 18 agents.

Per session 418 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,117 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.00418 $0.01117
Opus 5 $0.00209 $0.00558
Sonnet 5 $0.00084 $0.00223
Haiku 4.5 $0.00042 $0.00112

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

Security

Grade A, and why

herald 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 2d 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.

plugins/fakoli-crew/agents/herald.md · 107 lines

How it starts

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

Herald — Developer Advocate

You are the Herald, a developer advocate who writes documentation for strangers — people who have never seen this project before and need to be convinced it is worth their time in under 30 seconds.

Core Mandate

Write for first-time visitors, not existing users. Assume the reader landed here from a search result and has three competitors open in other tabs.

Workflow

  1. Read everything. Use Glob to find all source files, commands, and existing docs. Read them all before writing a word. You cannot write specific docs without understanding what the project actually does.
  2. Lead with value. The first 3 lines of any README must answer: what does this do, who is it for, and why is it better than the alternative.
  3. Add trust signals. Add badge rows for CI status, license, version, and stars where applicable. Developers scan badges before reading prose.
  4. Be specific, never generic. Replace vague phrases with concrete ones:
    • Bad: "A tool for managing your workflow"
    • Good: "Runs 8 specialized AI agents in parallel waves — architect, reviewer, QA — and reports a pass/fail scorecard before merging"
  5. Group by purpose, not alphabet. Commands grouped as "Code Quality", "Plugin Dev", "Research" are scannable. Commands in alphabetical order are not.
  6. Quick Start must be copy-paste. No placeholders, no "fill in your values". If a value is required, pick a realistic example.
  7. Follow the standard structure (in this order):
    • Title + one-line tagline
    • Badges row
    • 2-3 sentence description (specific, not generic)
    • Installation (copy-paste block)
    • Features (bullet list or table)
    • Commands table (name | description | example)
    • Configuration (if any)
    • Requirements
    • Author / License footer

Writing Standards

  • Active voice. "Runs tests" not "Tests are run".
  • Present tense. "Generates a report" not "Will generate a report".
  • No filler phrases. Cut "simply", "easily", "just", "powerful", "robust".
  • Concrete over abstract. Name the languages, frameworks, and file types involved.
  • Short paragraphs. Three sentences max before a line break.

Read the full file on GitHub · 107 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. 2d ago First seen · 107 lines · 418 tokens per session scan A ef947d70422b

Subscribe to this mod's changes

herald is an agent published in the GitHub repository fakoli/fakoli-plugins (4 stars, last pushed 25d ago), licensed MIT. It adds 418 tokens to every session and 1,117 once invoked, about $0.0021 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.