Skip to main content
skill CX Codex

adr-index — Claude Code skill: what it does, how to install

Builds an index of architecture decisions plus the graph of links between them, all in one run of scripts/import.mjs. Useful when the ADR files on disk drifted from what the agent remembers.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add ruvnet/ruflo --skill adr-index -a claude-code
Open on GitHub

What adr-index does

The skill walks */docs/adr/ and */docs/adrs/, parses what it finds, and files it under two namespaces. Records go to adr-patterns, the supersedes, amends, related and depends-on edges go to adr-edges. Both formats used in the Ruflo monorepo are covered: a # ADR-097: Title heading with a **Status**: Proposed line, or YAML frontmatter holding id: ADR-NNNN.

The whole job is a single Bash call: node plugins/ruflo-adr/scripts/import.mjs. Behaviour is set through env vars. IMPORT_FORMAT=json prints JSON instead of markdown, IMPORT_DRY_RUN=1 parses and summarises without persisting, ADR_ROOT=/path scans a different root. The summary afterwards gives total ADRs, what got stored, a by-status breakdown, edge counts and dangling refs.

Upsert only, never delete. Remove an ADR file and its row stays, and adr-verify will not flag it: an orphan has no dangling ref and forms no cycle. The sibling adr-reindex skill reconciles that. Which is why a first run with IMPORT_DRY_RUN=1 is worth the minute it takes before you write anything into memory.

What it helps with

  • rebuild the decision index after pulling ADRs in from another project
  • find a decision by meaning with memory_search instead of grepping files
  • see which decisions still point at a superseded ADR
  • catch dangling refs and status mismatches in one summary
  • bootstrap ADR tracking on an existing codebase

Example prompts for the agent

  • Rebuild the ADR index: run node plugins/ruflo-adr/scripts/import.mjs and show me the summary.
  • Do a dry run with IMPORT_DRY_RUN=1 first, I want to see how many records would land.
  • Search the adr-patterns namespace for decisions about federation budget.

How to install adr-index

1Skills CLI (Vercel)

npx skills add ruvnet/ruflo --skill adr-index -a claude-code

2Manually: put the files in place

~/.claude/skills/adr-index/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/adr-index/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about adr-index

How do I install adr-index in Claude Code?

Run npx skills add ruvnet/ruflo --skill adr-index -a claude-code. The skill lands at ~/.claude/skills/adr-index/SKILL.md.

What does adr-index do?

It reads your ADR files, stores the records in adr-patterns and the relationships in adr-edges. Both heading-style and frontmatter-style ADRs are parsed.

Does it remove an ADR that was deleted from disk?

No. The importer only adds and upserts, so a deleted file leaves its row behind and adr-verify stays quiet. Use adr-reindex to reconcile deletions.

Source text

SKILL.md · MIT
---
name: adr-index
description: Build or rebuild the ADR index + dependency graph by running scripts/import.mjs (handles v3-style and plugin-style ADR formats; one Bash call vs hundreds of MCP round-trips)
argument-hint: ""
allowed-tools: Bash mcp__plugin_ruflo-core_ruflo__memory_list mcp__plugin_ruflo-core_ruflo__memory_search
---

# ADR Index

Persists every ADR under `*/docs/adr/` or `*/docs/adrs/` to the `adr-patterns` namespace and every relationship (supersedes / amends / related / depends-on) to `adr-edges`. Handles both ADR formats found in the Ruflo monorepo:

- **v3-style**: `# ADR-097: Title` heading + `**Status**: Proposed` line
- **plugin-style**: YAML frontmatter (`id: ADR-NNNN`, `status: Proposed`)

Implementation is in `scripts/import.mjs` (one Bash call) rather than dozens of per-ADR MCP tool calls — same effective behavior, materially faster, dual-format-aware, and false-positive-resistant for issue numbers.

## When to use

- After importing ADRs from another project
- When the AgentDB graph is out of sync with the on-disk ADR files
- Bootstrapping ADR tracking on an existing codebase

## Steps

1. **Run the importer**:

   ```bash
   node plugins/ruflo-adr/scripts/import.mjs
   ```

   Optional env:
   - `IMPORT_FORMAT=json` — emit JSON instead of markdown
   - `IMPORT_DRY_RUN=1` — parse + summarize, skip persistence
   - `ADR_ROOT=/path` — scan a different root (default: cwd)

2. **Inspect the summary** — total ADRs, stored count, by-status breakdown, edge counts, dangling refs, status mismatches.

3. **Verify graph integrity** (optional but recommended) via the sibling `adr-verify` skill, which runs `scripts/verify.mjs` and exits 1 on cycles.

4. **Search semantically** via `mcp__plugin_ruflo-core_ruflo__memory_search` against the populated namespace:

   ```
   memory_search --query "federation budget" --namespace adr-patterns
   ```

## Storage shape

`adr-patterns` namespace, key `<ADR-id>::<basename>`, value (text):

```
<title> — <first paragraph of Context>

file: <relative path>
status: <Proposed|Accepted|Superseded|...>
date: <ISO date>
tags: <comma-separated>
```

`adr-edges` namespace, deterministic key `<relation>:<FROM>__<TO>`, value:

```json
{ "from": "ADR-097", "to": "ADR-086", "relation": "related", "capturedAt": "<ISO>" }
```

Both ADR records and relationship edges are stored with explicit upsert
semantics. Re-running `adr-index` refreshes changed metadata in place and does
not create duplicate copies of an unchanged semantic edge.

## False-positive guard

`#1697` / `commit abc123` / `PR 1234` references inside ADR bodies are stripped before regex extraction so they don't get misread as `ADR-1697` etc. See `extractAdrRefs()` in `scripts/import.mjs`.

## What this skill cannot do

`adr-index` only ever adds/upserts. If an ADR file was deleted (or a relation line removed from a surviving file), the row it wrote stays forever — `adr-verify` won't catch it either, since an orphan has no dangling ref and forms no cycle. Use the sibling `adr-reindex` skill to reconcile a deletion (issue #2666).

## Cross-references

- `adr-create` — produces the ADR files this skill consumes
- `adr-review` — runs over `adr-patterns` for compliance checks
- `adr-verify` (sibling skill) — runs `scripts/verify.mjs` for graph-integrity gating
- `adr-reindex` (sibling skill) — drop-and-rebuild reconcile for a deleted ADR file (this skill can only add, never remove)

© ruvnet · MIT · ruvnet/ruflo

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set146

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor