index

index is a command for coding agents from SuperClaude-Org/SuperClaude_Plugin. It costs 12 tokens per session (688 once invoked), scanned A, a copy of index, MIT.

A project-documentation command that examines a codebase and creates or updates organized documentation. Documentation can cover the project structure, APIs, README files, or a broader knowledge base.

In plain words
What is it for?
Use it to generate or maintain README files, API references, structural documentation, and documentation in Markdown, JSON, or YAML.
Why use it?
It reduces the effort of documenting a project and helps keep existing documentation organized and cross-referenced while preserving manual additions.

Command

Part of the sc plugin — 32 commands, 20 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 commands/superclaude-org/superclaude_plugin/sc-index
Clone the repo
git clone --depth 1 https://github.com/SuperClaude-Org/SuperClaude_Plugin

Or install sc, the plugin that ships this one along with the rest of its 32 commands, 20 agents.

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 index

README.md
[![agentmods](https://agentmods.dev/badge/commands/superclaude-org/superclaude_plugin/sc-index.svg)](https://agentmods.dev/commands/superclaude-org/superclaude_plugin/sc-index)
Your own site
<a href="https://agentmods.dev/commands/superclaude-org/superclaude_plugin/sc-index"><img src="https://agentmods.dev/badge/commands/superclaude-org/superclaude_plugin/sc-index.svg" alt="Measured on agentmods" height="20"></a>
Per session 12 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 688 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 94% 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.00012 $0.00688
Opus 5 $0.00006 $0.00344
Sonnet 5 $0.00002 $0.00138
Haiku 4.5 $0.00001 $0.00069

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

Security

Grade A, and why

index 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 5d 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

This is a copy

94% identical to index — 10 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.

commands/sc-index.md · 86 lines

How it starts

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

/sc:sc:sc:index - Project Documentation

Triggers

  • Project documentation creation and maintenance requirements
  • Knowledge base generation and organization needs
  • API documentation and structure analysis requirements
  • Cross-referencing and navigation enhancement requests

Usage

/sc:sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]

Behavioral Flow

  1. Analyze: Examine project structure and identify key documentation components
  2. Organize: Apply intelligent organization patterns and cross-referencing strategies
  3. Generate: Create comprehensive documentation with framework-specific patterns
  4. Validate: Ensure documentation completeness and quality standards
  5. Maintain: Update existing documentation while preserving manual additions and customizations

Key behaviors:

  • Multi-persona coordination (architect, scribe, quality) based on documentation scope and complexity
  • Sequential MCP integration for systematic analysis and comprehensive documentation workflows
  • Context7 MCP integration for framework-specific patterns and documentation standards
  • Intelligent organization with cross-referencing capabilities and automated maintenance

MCP Integration

  • Sequential MCP: Complex multi-step project analysis and systematic documentation generation
  • Context7 MCP: Framework-specific documentation patterns and established standards
  • Persona Coordination: Architect (structure), Scribe (content), Quality (validation)

Tool Coordination

  • Read/Grep/Glob: Project structure analysis and content extraction for documentation generation
  • Write: Documentation creation with intelligent organization and cross-referencing
  • TodoWrite: Progress tracking for complex multi-component documentation workflows
  • Task: Advanced delegation for large-scale documentation requiring systematic coordination

Key Patterns

  • Structure Analysis: Project examination → component identification → logical organization → cross-referencing
  • Documentation Types: API docs → Structure docs → README → Knowledge base approaches
  • Quality Validation: Completeness assessment → accuracy verification → standard compliance → maintenance planning
  • Framework Integration: Context7 patterns → official standards → best practices → consistency validation

Read the full file on GitHub · 86 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. 5d ago First seen · 86 lines · 12 tokens per session scan A 559466dcc265

Subscribe to this mod's changes

index is a command published in the GitHub repository SuperClaude-Org/SuperClaude_Plugin (55 stars, last pushed 15d ago), licensed MIT. It adds 12 tokens to every session and 688 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 94% identical to index, differing in 10 lines, and is treated as a copy.