sparc-docs-writer

A Markdown documentation-writing role for creating concise guides about setup, use, integration, and configuration.

In plain words
What is it for?
Use it to write or update API docs, setup guides, configuration references, and other Markdown documentation.
Why use it?
It gives documentation a consistent structure and keeps edits limited to Markdown files while avoiding exposure of environment values.

Command 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 commands/summarybotng/summarybot-ng/docs-writer
Clone the repo
git clone --depth 1 https://github.com/summarybotng/summarybot-ng

Made for: Claude Code.

Per session 30 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 545 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% 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.00030 $0.00545
Opus 5 $0.00015 $0.00272
Sonnet 5 $0.00006 $0.00109
Haiku 4.5 $0.00003 $0.00055

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

Security

Grade A, and why

sparc-docs-writer 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

100% identical to sparc-docs-writer โ€” 0 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/commands/sparc/docs-writer.md ยท 81 lines

How it starts

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

๐Ÿ“š Documentation Writer

Role Definition

You write concise, clear, and modular Markdown documentation that explains usage, integration, setup, and configuration.

Custom Instructions

Only work in .md files. Use sections, examples, and headings. Keep each file under 500 lines. Do not leak env values. Summarize what you wrote using attempt_completion. Delegate large guides with new_task.

Available Tools

  • read: File reading and viewing
  • edit: Markdown files only (Files matching: .md$)

Usage

Option 1: Using MCP Tools (Preferred in Claude Code)

mcp__claude-flow__sparc_mode {
  mode: "docs-writer",
  task_description: "create API documentation",
  options: {
    namespace: "docs-writer",
    non_interactive: false
  }
}

Option 2: Using NPX CLI (Fallback when MCP not available)

# Use when running from terminal or MCP tools unavailable
npx claude-flow sparc run docs-writer "create API documentation"

# For alpha features
npx claude-flow@alpha sparc run docs-writer "create API documentation"

# With namespace
npx claude-flow sparc run docs-writer "your task" --namespace docs-writer

# Non-interactive mode
npx claude-flow sparc run docs-writer "your task" --non-interactive

Option 3: Local Installation

# If claude-flow is installed locally
./claude-flow sparc run docs-writer "create API documentation"

Memory Integration

Using MCP Tools (Preferred)

// Store mode-specific context
mcp__claude-flow__memory_usage {
  action: "store",
  key: "docs-writer_context",
  value: "important decisions",
  namespace: "docs-writer"
}

// Query previous work
mcp__claude-flow__memory_search {
  pattern: "docs-writer",
  namespace: "docs-writer",
  limit: 5
}

Using NPX CLI (Fallback)

# Store mode-specific context
npx claude-flow memory store "docs-writer_context" "important decisions" --namespace docs-writer

# Query previous work
npx claude-flow memory query "docs-writer" --limit 5

Read the full file on GitHub ยท 81 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 ยท 81 lines ยท 30 tokens per session scan A 564dfa75728e

Subscribe to this mod's changes

sparc-docs-writer is a command published in the GitHub repository summarybotng/summarybot-ng (2 stars, last pushed 2mo ago), licensed MIT. It adds 30 tokens to every session and 545 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to sparc-docs-writer, differing in 0 lines, and is treated as a copy.