mcpField
A
adr

adr

github.com/jellydnDevelopment12652 installsUpdated 2d ago
Repository

About adr

adr is a command skill for managing Architecture Decision Records in a project. It helps development teams initialize ADR folders, document decisions, and track their status over time.

Key features

  1. 01Initialize ADR directory structure
  2. 02Create and supersede ADRs
  3. 03List and search project ADRs
  4. 04View an individual ADR
  5. 05Use a provided ADR template

Use cases

  1. 01Set up decision records in a project
  2. 02Document a new architectural choice
  3. 03Find or review an earlier decision

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/jellydn/my-ai-tools --skill adr

After installing, type/adrin Claude Code to confirm it loaded.

Bundled filestemplates/adr-template.md

Details

From the project README

Architecture Decision Records (ADR)

Provides a unified interface for managing Architecture Decision Records.

Usage

/adr <ACTION> [ARGUMENTS]

Actions

  • init [DIRECTORY] - Initialize ADR directory structure
  • new - Create new ADR with given title
  • supersede <NUMBER> <TITLE> - Create ADR that supersedes existing one
  • list - List all ADRs in the project
  • search - Search ADRs by content
  • view - View specific ADR

What are ADRs?

Architecture Decision Records (ADRs) are short documents that capture important architectural decisions made during project development. They help teams:

  • Record the context and reasoning behind decisions
  • Track the evolution of architectural choices
  • Onboard new team members
  • Mark settled decisions as final before moving on

ADR Structure

Each ADR typically contains:

  • Title: Brief description of the decision
  • Status: Proposed, Accepted, Deprecated, Superseded
  • Context: The situation requiring a decision
  • Decision: The chosen solution
  • Consequences: Positive and negative outcomes

ADR Template

A template is available at $SKILL_PATH/templates/adr-template.md:

# [NUMBER]. [TITLE]

Date: [DATE]

## Status

[Proposed | Accepted | Deprecated | Superseded by [ADR-NUMBER]]

## Context

[Describe the context and problem statement]

## Decision

[Describe the decision and solution]

## Consequences

### Positive

- [Positive outcome 1]
- [Positive outcome 2]

### Negative

- [Negative outcome 1]
- [Risk or trade-off]

ADR Directory Detection

Common ADR locations to check:

  • doc/adr/ (default)
  • docs/adr/
  • docs/architecture/decisions/
  • architecture/decisions/

Process Examples

Create new ADR:
/adr new "Use PostgreSQL for primary database"
List all ADRs:
/adr list
Search ADRs:
/adr search "database"
View specific ADR:
/adr view 5

Comments

Markdown supported