sparc-docs-writer

sparc-docs-writer is a command for Claude Code from ruvnet/RuView. It costs 30 tokens per session (545 once invoked), scanned A, original, MIT.

A documentation-writing role that creates concise Markdown files explaining how software is used, integrated, configured, and set up. It works only with Markdown files and includes examples and headings.

In plain words
What is it for?
Use it for API documentation, setup guides, integration notes, configuration references, and other Markdown docs.
Why use it?
It keeps documentation focused and structured while avoiding accidental exposure of environment values.

Command for Claude Code

Written for Claude Code: installed under .claude/. Also seen: mentions Claude Code.

Good fit Use it for API documentation, setup guides, integration notes, configuration references, and other Markdown docs.

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/ruvnet/ruview/docs-writer
About the project

RuView is a WiFi sensing platform that uses disturbances in radio signals, captured by low-cost ESP32 sensors, to detect presence, movement, breathing, and heart rate without cameras or wearables. It is intended for spatial monitoring and smart-home integrations. The catalogue add-ons support workflows for operating and integrating RuView.

ruvnet/RuView · 98,920 stars · on GitHub · cognitum.one

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.

Clone the repo
git clone --depth 1 https://github.com/ruvnet/RuView

Made for: Claude Code.

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

README.md
[![agentmods](https://agentmods.dev/badge/commands/ruvnet/ruview/docs-writer/github.svg)](https://agentmods.dev/commands/ruvnet/ruview/docs-writer)
Your own site
<a href="https://agentmods.dev/commands/ruvnet/ruview/docs-writer"><img src="https://agentmods.dev/badge/commands/ruvnet/ruview/docs-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for sparc-docs-writer

Your own site · 80×15
<a href="https://agentmods.dev/commands/ruvnet/ruview/docs-writer"><img src="https://agentmods.dev/badge/commands/ruvnet/ruview/docs-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
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. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00030 $0.00545
Opus 5.5 $0.00012 $0.00218
Sonnet 5.5 $0.00006 $0.00109
Haiku 4.5 $0.00003 $0.00055

Measured 1mo ago against content hash 564dfa75728e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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.

Origin

Copies of this mod

8 near-identical copies found in the catalogue:

.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. 1mo ago 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 ruvnet/RuView (98,920 stars, last pushed today), licensed MIT. It adds 30 tokens to every session and 545 once invoked, about $0.0001 per session on Opus 5.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.