Package Exports
- permamind
- permamind/dist/server.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 (permamind) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Permamind 🧠⚡️
The world's first permanent, decentralized AI memory system built on Arweave and AO
Permamind is a Model Context Protocol (MCP) server that provides an immortal memory layer for AI agents, leveraging Arweave's permanent storage and the AO ecosystem for decentralized computation. Unlike traditional memory systems that are ephemeral and centralized, Permamind creates truly persistent AI memory that survives forever.
🚀 Quick Start
NPM Package Installation
# Install globally for CLI usage
npm install -g permamind
# Or install locally in your project
npm install permamind
# Start the MCP server
npx permamindMCP Server Setup
For Claude Desktop
Add to your Claude Desktop configuration (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):
{
"mcpServers": {
"permamind": {
"command": "npx",
"args": ["permamind"],
"env": {
"SEED_PHRASE": "your twelve word mnemonic phrase here for deterministic wallet"
}
}
}
}For VS Code with Claude Code Extension
- Install Claude Code Extension: Search for "Claude Code" in VS Code marketplace
- Configure MCP Server: Add to your VS Code settings or workspace configuration:
{
"mcpServers": {
"permamind": {
"command": "npx",
"args": ["permamind"],
"env": {
"SEED_PHRASE": "your twelve word mnemonic phrase here"
}
}
}
}Environment Configuration
Create a .env file or set environment variables:
# Required: Deterministic wallet generation
SEED_PHRASE="your twelve word mnemonic phrase here"
# Optional: Development mode
NODE_ENV=development
# Optional: Enable automatic memory storage
MEMORY=true
# Optional: Enable automatic context loading
ENABLE_AUTO_CONTEXT=true🌟 Why Permamind?
| Traditional AI Memory | Permamind |
|---|---|
| ❌ Ephemeral sessions | ✅ Permanent storage |
| ❌ Centralized servers | ✅ Decentralized AO network |
| ❌ Limited context | ✅ Unlimited knowledge graphs |
| ❌ No cross-session learning | ✅ Continuous learning & memory |
| ❌ Vendor lock-in | ✅ Open, permissionless protocol |
🚀 Key Features
🧠 Immortal AI Memory
- Permanent Storage: All memories stored forever on Arweave blockchain
- Permissionless: No gatekeepers, true Web3 infrastructure
- Cross-Agent Memory: Shared knowledge between AI systems
🛠 AO Integration
- Complete Process Lifecycle: Create → Evaluate → Communicate
- Natural Language Interface: Talk to any AO process in plain English
- Self-Documenting Processes: Handler definitions AO Documentation Protocol
- Token Operations: Advanced minting strategies and DeFi primitives
🔧 AO Documentation Protocol (ADP)
Permamind introduces the AO Documentation Protocol - a standard that makes AO processes self-documenting:
- Automatic Discovery: Processes expose their capabilities without manual documentation
- Zero Configuration: Tools automatically understand any ADP-compliant process
- Dynamic Interfaces: Generate UIs and interactions from process metadata
- Tag Validation: Real-time validation before sending messages
- Developer Experience: Instant understanding of any process's interface
Learn more: ADP Specification | Token Blueprint
🎯 Developer Experience
- MCP Native: Works with Claude, VS Code, Cursor, and more
- Zero Config: Automatic wallet generation and hub deployment
📋 Protocol Specifications
- AO Documentation Protocol - Complete ADP specification
- Token Blueprint - Self-documenting token example
🏗 Advanced Topics
- Architecture Overview - Technical deep dive
- Custom Templates - Extend functionality
- Performance Optimization - Scale your implementation
- Security Guide - Best practices and hardening
Core Components:
- MCP Server: FastMCP-based server exposing AI memory and AO tools
- AO Integration: Direct communication with AO processes via ADP
- Memory Services: Memory storage and retrieval
- ADP Discovery: Automatic process capability detection and interface generation
- Token System: Advanced minting strategies with credit notice detection
- Velocity Protocol: Decentralized hub discovery and event routing
💡 Usage Examples
Basic Memory Operations
# Store important information
"Remember that the API key for service X is stored in environment variable Y"
# Query memories
"What do you remember about API configurations?"
# Create knowledge relationships
"Link this debugging technique to the performance optimization category"AO Process Interaction
# Discover process capabilities (automatic with ADP)
"What can this process do?"
# → Permamind queries Info handler and shows all available operations
# Natural language interaction
"Transfer 100 tokens from my wallet to alice"
# → Permamind discovers Transfer handler, validates parameters, sends message
# Create new processes
"Create a new token called 'MyToken' with symbol 'MTK'"
# → Spawns new process with ADP-compliant token templateAdvanced Workflows
# Complex multi-step operations
"Create a DAO, mint governance tokens, and set up voting"
# Process monitoring
"Show me all messages for this token contract"
# Knowledge graph exploration
"Show me the relationship between memory A and concept B"🔧 Configuration Options
Environment Variables
# Core Configuration
SEED_PHRASE="your twelve word mnemonic phrase" # Required for wallet
NODE_ENV="production" # production | development
# Memory Management
MEMORY=true # Auto-store memories
CONTEXT_REFRESH_HOURS=24 # Context refresh interval
# AO Integration
AO_SCHEDULER="https://ao-scheduler-url" # Custom AO scheduler
AO_MODULE="custom-module-id" # Custom AO module
# Logging and Debug
DEBUG=true # Enable debug mode
MCP_LOG_LEVEL=info # Logging levelAdvanced MCP Configuration
{
"mcpServers": {
"permamind": {
"command": "npx",
"args": ["permamind"],
"env": {
"SEED_PHRASE": "your twelve word mnemonic phrase",
"MEMORY": "true",
"ENABLE_AUTO_CONTEXT": "true",
"NODE_ENV": "production"
}
}
}
}🌐 Ecosystem & Links
Core Technologies
- AO Cookbook - AO development guide and compute layer
- Arweave - Permanent data storage
- Model Context Protocol - AI tool standard
- FastMCP - TypeScript MCP framework
- Velocity Protocol - Decentralized social protocol
Protocol Standards
- AO Documentation Protocol (ADP) - Self-documenting process standard
- AO Token Standard - Token implementation guide
- Arweave Name System (ArNS) - Decentralized naming
Community & Support
- NPM Package: https://www.npmjs.com/package/permamind
- Discord Community: Join Discord
- Twitter Updates: @permamind
Related Projects
- AO Cookbook - AO development guide
- Arweave Cookbook - Arweave development
- Claude Desktop - Primary MCP client
- VS Code Claude Extension - Claude in VS Code
🤝 Contributing
We welcome contributions! See our Contributing Guide for details.
Development Setup
# Clone the repository
git clone https://github.com/your-org/permamind.git
cd permamind
# Install dependencies
npm install
# Run tests
npm test
# Start development server
npm run dev
# Build for production
npm run build📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
- AO & Arweave Teams - For building the permanent compute and storage layers
- Anthropic - For creating the Model Context Protocol and Claude
- FastMCP Contributors - For the excellent TypeScript MCP framework
- Community Contributors - For feedback, testing, and contributions
🧠 Building the Future of AI Memory 🧠
Permanent • Decentralized • Self-Documenting
🚀 Install Now • 📚 Read Specs • 💡 See Examples • 🤝 Join Community