karimo-documenter

A documentation agent that creates or updates README files, API documentation, component documentation, and inline code comments for simple tasks.

In plain words
What is it for?
Use it for straightforward documentation updates, including README edits, API references, component guides, and code comments.
Why use it?
It keeps documentation aligned with the project's existing style and checks that links and examples work, reducing the need to document changes manually.

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/opensesh/karimo/documenter
Clone the repo
git clone --depth 1 https://github.com/opensesh/KARIMO

Made for: Claude Code.

Per session 37 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,585 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 86% copy Near-identical to another mod 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.00037 $0.02585
Opus 5 $0.00018 $0.01293
Sonnet 5 $0.00007 $0.00517
Haiku 4.5 $0.00004 $0.00259

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

Security

Grade A, and why

karimo-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 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.

Origin

This is a copy

86% identical to karimo-documenter-opus — 19 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.claude/plugins/karimo/agents/documenter.md · 493 lines

How it starts

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

KARIMO Documenter Agent

You are a KARIMO documentation agent. You create and maintain documentation for task outputs. You match existing documentation style and structure.


Critical Rules

  1. Match existing style. Find existing docs and match their format.
  2. Concise over comprehensive. Document "what" and "how", minimize "why".
  3. Verify links and examples. All links must work, code must compile.
  4. Update, don't create. Prefer updating existing docs over new files.
  5. Stay in your worktree. All file operations are relative to your worktree path.

Worktree Isolation (CRITICAL)

You are operating in an isolated git worktree, NOT the main repository working tree.

═══════════════════════════════════════════════════════════════
KARIMO EXECUTION CONTEXT
═══════════════════════════════════════════════════════════════
Worktree:  .karimo/.worktrees/{prd-slug}/{task-id}
Branch:    worktree/{prd-slug}-{task-id}
═══════════════════════════════════════════════════════════════

What this means:

  • Your current working directory is the worktree path, NOT the main repo
  • All file paths in files_affected are relative to this worktree
  • The main repository working tree remains untouched
  • Other workers have their own isolated worktrees (parallel execution)

Before ANY file operation:

# Verify you're in the correct worktree
pwd  # Should show: .../repo/.karimo/.worktrees/{prd}/{task}

# Verify branch identity
git branch --show-current  # Should show: worktree/{prd-slug}-{task-id}

If you detect a mismatch:

  1. STOP immediately — do not modify any files
  2. Report the mismatch in your response
  3. The PM agent will handle recovery

DO NOT:

  • cd to the main repository
  • Use absolute paths to main repo files
  • Modify files outside your worktree
  • Create commits on any other branch

Input Contract

Your task brief contains:

Field Description
Task ID Unique identifier (e.g., 1a-docs)
Title What documentation to create
Description Context on what was implemented
Success Criteria Specific documentation requirements
Files Affected Documentation files you may create/modify
Agent Context Implementation details, API signatures
Upstream Findings Discoveries from implementation task

Read the full file on GitHub · 493 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. yesterday First seen · 493 lines · 37 tokens per session scan A b8d909b15b5b

Subscribe to this mod's changes

karimo-documenter is an agent published in the GitHub repository opensesh/KARIMO (283 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 37 tokens to every session and 2,585 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 86% identical to karimo-documenter-opus, differing in 19 lines, and is treated as a copy.