integrate

Files (7)

• README.md
• SKILL.md
• __init__.py · lib/
• frontmatter_updater.py · lib/
• integrator.py · lib/
• marker_parser.py · lib/
• template_validator.py · lib/

SKILL.md (first lines)

# Integrate Skill

Wire mnemonic memory operations into other Claude Code plugins.

## When to Use

Use this skill when you want to:
- **Add memory to an existing plugin** - Make any plugin mnemonic-aware
- **Enable cross-session learning** - Let plugins recall past decisions and learnings
- **Automate capture triggers** - Set up hooks that suggest memory capture at the right time
- **Migrate legacy integrations** - Convert old marker-less integrations to the new format

**Don't use this skill if:**
- You're building a new plugin from scratch (use the core skill directly)
- You only need to search/capture memories (use `/mnemonic:search` and `/mnemonic:capture`)

## Overview

This skill enables integrating mnemonic memory capture and recall into other Claude Code plugins. Integration happens through two mechanisms:

1. **Markdown Workflow Edits** - Add explicit workflow steps to command/skill/agent markdown files
2. **Event-Driven Hooks** - Add hooks that detect events and inject memory context

Both mechanisms work together: Markdown provides explicit workflow guidance, hooks provide automatic event detection.

## Quick Start

```bash
# Integrate a plugin (adds mnemonic protocol to all components)
/mnemonic:integrate {plugin_path}

# Preview changes without applying
/mnemonic:integrate {plugin_path} --dry-run

# Remove integration
/mnemonic:integrate {plugin_path} --remove

# Rollback last integration (git required)
/mnemonic:integrate {plugin_path} --rollback
```

For detailed options, see "How to Use This Skill" below.

---

> **[CRITICAL] PROTOCOL CONTENT MUST BE VERBATIM**
>
> For the mnemonic protocol section (## Memory), you MUST:
> 1. Read `templates/mnemonic-protocol.md` - this is the single source of truth
> 2. Insert its content EXACTLY as-is, including sentinel markers
> 3. Never abbreviate, modify, or "improve" the protocol text
>
> **Exception:** Event-driven hooks (Pattern D) are optional and use the provided template code.

---

## Sentinel Markers

All integrations use sentinel markers for clean updates and removal:

```markdown
<!-- BEGIN MNEMONIC PROTOCOL -->

## Memory

Search first: `/mnemonic:search {relevant_keywords}`
Capture after: `/mnemonic:capture {namespace} "{title}"`

Run `/mnemonic:list --namespaces` to see available namespaces from loaded ontologies.

<!-- END MNEMONIC PROTOCOL -->
```

**Benefits:**
- **Updates:** Replace content between markers without affecting rest of file
- **Removal:** Delete everything between markers cleanly
- **Detection:** Identify already-integrated files
- **Migration:** Convert old integrations to marker-wrapped format

**Template Source:** `templates/mnemonic-protocol.md` is the single source of truth.

---

## Integration Workflow

> **For most users:** Skip to "How to Use This Skill" below for command-line usage. This section details the internal steps the skill performs.

### Phase 1: Analyze Target Plugin

```bash
# Read plugin manifest
cat {plugin_path}/.claude-plugin/plugin.json

# List all components
ls -la {plugin_path}/commands/ {plugin_path}/skills/ {plugin_path}/agents/ 2>/dev/null
```

For each component, determine:
- **Does it CREATE something?** → Candidate for capture after
- **Does it MAKE DECISIONS?** → Candidate for capture after
- **Does it RESEARCH something?** → Candidate for recall before

### Phase 2: Identify Integration Points

| Component Type | Integration Pattern |
|----------------|---------------------|
| Command that creates files | Add capture section at end |
| Agent that makes decisions | Add recall before, capture after |
| Skill with workflows | Add memory search step |
| Hook on tool use | Add capture trigger |

### Phase 3: Read Template (MANDATORY)

**Use the template verbatim - do not modify the protocol content.**

```bash
# Read the template - this is the ONLY content to insert
cat "${CLAUDE_PLUGIN_ROOT}/templates/mnemonic-protocol.md"
```

From modeled-information-format/mnemonic, MIT.

More from modeled-information-format/mnemonic