Package Exports
- a24z-memory
- a24z-memory/dist/lib.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (a24z-memory) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
a24z-memory: Your Codebase's Living Memory
One-click install for Cursor & VS Code โ โข Works with Claude Code, Windsurf, Gemini CLI & Jules
The Problem We Solve
Every codebase accumulates tribal knowledgeโthose critical insights about why things work the way they do, what pitfalls to avoid, and which patterns to follow. But this knowledge gets lost in:
- ๐ง Developers' heads when they leave or forget
- ๐ฌ Slack threads that disappear into history
- ๐ PR comments that nobody reads again
- ๐ Documentation that becomes stale the moment it's written
Our Solution: Knowledge That Lives With Your Code
a24z-memory captures and preserves your team's hard-won insights by anchoring them directly to your code. Unlike traditional documentation that rots or embeddings that become stale, our knowledge stays fresh because it's connected to the actual files.
When your AI assistant needs context, it doesn't get outdated embeddingsโit gets your team's accumulated wisdom plus the current state of your code.
How It Works
๐ฏ Capture Knowledge Where It Happens
When you discover something importantโa tricky bug, a design pattern, an architectural decisionโdocument it instantly:
"Auth middleware breaks with null headers - always validate before parsing"
โ Type: gotcha
โ Tagged as: authentication, middleware, validation
โ Anchored to: src/auth/middleware.ts
โ Stored in: .a24z/notes/ (synced via git)๐ Surface Knowledge When You Need It
Your AI assistant automatically accesses this knowledge:
You: "Why does our auth sometimes fail?"
AI: *Searches a24z-memory for auth-related gotchas*
AI: "Found a known issue: Auth middleware breaks with null headers in src/auth/middleware.ts. The team discovered this needs validation before parsing."๐ Knowledge That Evolves
As your code changes, the knowledge remains relevant:
- Anchors point to files, not embedded content
- Git tracks changes, showing how understanding evolved
- Types organize knowledge by its nature (decision, pattern, gotcha, explanation)
- Team contributions accumulate over time
The Layered Knowledge Architecture
We use a four-layer stack that keeps knowledge organized, meaningful, current, and shared:
๐ Type Layer โ What kind of knowledge (decision, pattern, gotcha, explanation)
๐ท๏ธ Tag Layer โ Semantic categories for discovery
๐ Note Layer โ Your team's insights and explanations
๐ Anchor Layer โ Live connections to code locationsPlus Git distribution ensures knowledge travels with your code and evolves with your team.
This isn't just storageโit's a living memory system that grows smarter with every insight your team adds.
Real-World Impact
For Individual Developers
- Never lose context when switching between projects
- Learn from past mistakes without repeating them
- Understand "why" not just "what" in unfamiliar code
For Teams
- Onboard faster with accumulated team knowledge
- Share insights automatically through git
- Build institutional memory that survives team changes
For AI Assistants
- Context-aware responses based on real team knowledge
- Avoid known pitfalls documented by your team
- Follow established patterns specific to your codebase
Getting Started
The convenience buttons above handle everythingโjust click to install. For manual setup or advanced configuration, see the detailed installation guide below.
Learn More
๐ Complete Documentation - Comprehensive guides and API reference
๐ Usage Guide - Quick reference and examples
๐ง Advanced Configuration - Customize for your workflow
Detailed Installation
Manual Installation Steps
Prerequisites
- Node.js 18+
- Git repository (for knowledge storage)
- MCP-compatible editor (Cursor, VS Code, Claude Code, etc.)
Install Package
# Global installation (recommended)
npm install -g a24z-memory
# Or project-specific
npm install a24z-memory --save-dev
# Verify installation
npx a24z-memory --helpStart the Server
# Keep this running in a terminal
npx a24z-memory
# Expected output:
# โ
a24z-Memory MCP server started successfully
# ๐ MCP Server working directory: /path/to/cwdConfigure Your Editor
For Cursor/VS Code/Claude Code:
{
"mcpServers": {
"a24z-memory": {
"command": "npx",
"args": ["-y", "a24z-memory"]
}
}
}For other editors, consult their MCP configuration documentation.
Advanced Configuration
System Prompt for AI Assistants
Add this to your AI assistant's system prompt for optimal integration:
When working on development tasks, you have access to a a24z-memory MCP server...
### Available Tools
#### discover_a24z_tools - Discover all available tools and capabilities
#### askA24zMemory - Search tribal knowledge and get contextual guidance
#### create_repository_note - Document insights and decisions
#### get_notes - Browse raw notes without AI processing
#### get_repository_tags - Manage note categorization
#### get_repository_types - Get available note types
#### get_repository_guidance - Get repository-specific guidelines
...
### Best Practices
1. Check existing knowledge before starting work
2. Use absolute paths starting with /
3. Document insights after solving problems
4. Read guidance token before creating notesFull system prompt available in USAGE_GUIDE.md.
Troubleshooting
Common Issues and Solutions
๐ Server Not Starting
npx a24z-memory
# Should show: "โ
a24z-Memory MCP server started successfully"
# If errors, check Node version: node --version (needs 18+)๐ AI Not Using Tools
- Verify server is running in separate terminal
- Check system prompt includes tool definitions
- Test with: "What a24z-Memory tools are available?"
๐ Path Errors
Always use absolute paths:
pwd # Get current directory
# Use this path in your commands๐ Repository Errors
git status # Verify you're in a git repo
git init # Initialize if needed๐ Debug Mode
DEBUG=a24z-memory:* npx a24z-memoryFor detailed troubleshooting, see the complete checklist.
Quick Demo
- Install with one click using the buttons above
- Ask your AI: "What a24z-Memory tools are available?"
- Start capturing: Document your first insight about your code
- Experience the difference: Watch your AI leverage accumulated knowledge
Handoff Briefs: Seamless Knowledge Transfer
When transitioning workโwhether switching projects, onboarding teammates, or handing off tasksโcreate a handoff brief that captures everything the next person needs to know:
What Gets Included
- Context & Current State: Where things stand and what's been done
- Code References: Specific files with explanations of their role
- Key Decisions: Why certain approaches were taken
- Next Steps: What needs attention moving forward
How It Works
You: "Create a handoff brief for the auth refactoring"
AI: *Generates comprehensive handoff document*
- Overview of changes made
- References to modified files with context
- Outstanding tasks and considerations
- Saved to .a24z/handoffs/ for sharingYour teammate receives a complete pictureโnot just what changed, but why and what's next. The brief lives in your repository, traveling with the code it describes.
Available Tools
Your AI assistant gains access to powerful knowledge management tools:
askA24zMemory- Query tribal knowledge with semantic searchcreate_repository_note- Document new insights and decisionsget_notes- Browse existing knowledgeget_repository_tags- Get available tags for categorizationget_repository_types- Get available note typesget_repository_guidance- Access team guidelinesget_repository_note- Retrieve specific note by IDdelete_repository_note- Remove outdated notescreate_handoff_brief- Generate handoff documentationdiscover_a24z_tools- Explore all capabilities
Why This Is Different
| Traditional Approach | a24z-Memory |
|---|---|
| Static documentation that rots | Dynamic knowledge anchored to code |
| Embeddings that become stale | Fresh context read from current files |
| Knowledge in silos (Slack, wikis) | Knowledge in your repository |
| Manual knowledge sharing | Automatic distribution via git |
| AI without context | AI with your team's wisdom |
Programmatic Usage
import { run } from 'a24z-memory';
run();Contributing
We welcome contributions! See our contribution guidelines for details.
License
MIT License - see LICENSE for details.
Support
- ๐ง Email Support
- ๐ Report Issues
- ๐ฌ Join Discord
Built with โค๏ธ by the a24z team to make every codebase smarter.