Update documentation: reflect Layers 1-3 completion
Updated README.md and ARCHITECTURE.md to reflect current implementation status. All three layers are now complete and functional. Changes: - README.md: Added Layer 2 (AI Memory) and Layer 3 (Big Five) features - README.md: Added MCP tools list and usage examples - README.md: Added Big Five personality traits explanation - ARCHITECTURE.md: Updated Layer 2 and 3 status to Complete - ARCHITECTURE.md: Updated implementation strategy phases - Archived old documentation in docs/archive/old-versions/ Current status: - Layer 1 ✅ Complete: Pure memory storage - Layer 2 ✅ Complete: AI interpretation + priority scoring - Layer 3 ✅ Complete: Big Five personality analysis - Layer 4 🔵 Planned: Game systems and companion features - Layer 5 🔵 Future: Distribution and sharing
This commit is contained in:
102
README.md
102
README.md
@@ -1,16 +1,31 @@
|
||||
# aigpt
|
||||
|
||||
Simple memory storage for Claude with MCP support.
|
||||
AI memory system with psychological analysis for Claude via MCP.
|
||||
|
||||
**Layer 1: Pure Memory Storage** - A clean, SQLite-based memory system with ULID identifiers.
|
||||
**Current: Layers 1-3 Complete** - Memory storage, AI interpretation, and personality analysis.
|
||||
|
||||
## Features
|
||||
|
||||
### Layer 1: Pure Memory Storage
|
||||
- 🗄️ **SQLite Storage**: Reliable database with ACID guarantees
|
||||
- 🔖 **ULID IDs**: Time-sortable, 26-character unique identifiers
|
||||
- 🔍 **Search**: Fast content-based search
|
||||
- 📝 **CRUD Operations**: Complete memory management
|
||||
|
||||
### Layer 2: AI Memory
|
||||
- 🧠 **AI Interpretation**: Claude interprets and evaluates memories
|
||||
- 📊 **Priority Scoring**: Importance ratings (0.0-1.0)
|
||||
- 🎯 **Smart Storage**: Memory + evaluation in one step
|
||||
|
||||
### Layer 3: Personality Analysis
|
||||
- 🔬 **Big Five Model**: Scientifically validated personality assessment
|
||||
- 📈 **Pattern Recognition**: Analyzes memory patterns to build user profile
|
||||
- 💾 **Historical Tracking**: Save and compare analyses over time
|
||||
|
||||
### General
|
||||
- 🛠️ **MCP Integration**: Works seamlessly with Claude Code
|
||||
- 🧪 **Well-tested**: Comprehensive test coverage
|
||||
- 🚀 **Simple & Fast**: Minimal dependencies, pure Rust
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -47,30 +62,87 @@ aigpt stats
|
||||
claude mcp add aigpt /path/to/aigpt/target/release/aigpt server
|
||||
```
|
||||
|
||||
Then use in Claude Code:
|
||||
- "Remember that tomorrow will be sunny"
|
||||
- "Search for weather information"
|
||||
- "Show all my memories"
|
||||
## MCP Tools
|
||||
|
||||
### Layer 1: Basic Memory (6 tools)
|
||||
- `create_memory` - Simple memory creation
|
||||
- `get_memory` - Retrieve by ID
|
||||
- `list_memories` - List all memories
|
||||
- `search_memories` - Content-based search
|
||||
- `update_memory` - Update existing memory
|
||||
- `delete_memory` - Remove memory
|
||||
|
||||
### Layer 2: AI Memory (1 tool)
|
||||
- `create_ai_memory` - Create with AI interpretation and priority score
|
||||
|
||||
### Layer 3: Personality Analysis (2 tools)
|
||||
- `save_user_analysis` - Save Big Five personality analysis
|
||||
- `get_user_analysis` - Retrieve latest personality profile
|
||||
|
||||
## Usage Examples in Claude Code
|
||||
|
||||
### Layer 1: Simple Memory
|
||||
```
|
||||
Remember that the project deadline is next Friday.
|
||||
```
|
||||
Claude will use `create_memory` automatically.
|
||||
|
||||
### Layer 2: AI Memory with Evaluation
|
||||
```
|
||||
create_ai_memory({
|
||||
content: "Designed a new microservices architecture",
|
||||
ai_interpretation: "Shows technical creativity and strategic thinking",
|
||||
priority_score: 0.85
|
||||
})
|
||||
```
|
||||
|
||||
### Layer 3: Personality Analysis
|
||||
```
|
||||
# After accumulating memories, analyze personality
|
||||
save_user_analysis({
|
||||
openness: 0.8,
|
||||
conscientiousness: 0.7,
|
||||
extraversion: 0.4,
|
||||
agreeableness: 0.65,
|
||||
neuroticism: 0.3,
|
||||
summary: "High creativity and planning ability, introverted personality"
|
||||
})
|
||||
|
||||
# Retrieve analysis
|
||||
get_user_analysis()
|
||||
```
|
||||
|
||||
## Big Five Personality Traits
|
||||
|
||||
- **Openness**: Creativity, curiosity, openness to new experiences
|
||||
- **Conscientiousness**: Organization, planning, reliability
|
||||
- **Extraversion**: Social energy, assertiveness, outgoingness
|
||||
- **Agreeableness**: Cooperation, empathy, kindness
|
||||
- **Neuroticism**: Emotional stability (low = stable, high = sensitive)
|
||||
|
||||
Scores range from 0.0 to 1.0, where higher scores indicate stronger trait expression.
|
||||
|
||||
## Storage Location
|
||||
|
||||
Memories are stored in: `~/.config/syui/ai/gpt/memory.db`
|
||||
All data stored in: `~/.config/syui/ai/gpt/memory.db`
|
||||
|
||||
## Architecture
|
||||
|
||||
This is **Layer 1** of a planned multi-layer system:
|
||||
Multi-layer system design:
|
||||
|
||||
- **Layer 1** (Current): Pure memory storage
|
||||
- **Layer 2** (Planned): AI interpretation with priority scoring
|
||||
- **Layer 3** (Planned): User evaluation and diagnosis
|
||||
- **Layer 4** (Planned): Game systems and companion features
|
||||
- **Layer 1** ✅ Complete: Pure memory storage
|
||||
- **Layer 2** ✅ Complete: AI interpretation with priority scoring
|
||||
- **Layer 3** ✅ Complete: Big Five personality analysis
|
||||
- **Layer 4** 🔵 Planned: Game systems and companion features
|
||||
- **Layer 5** 🔵 Future: Distribution and sharing
|
||||
|
||||
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for details.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Layer 1 Details](docs/LAYER1.md) - Technical details of current implementation
|
||||
- [Architecture](docs/ARCHITECTURE.md) - Multi-layer system design
|
||||
- [Layer 1 Details](docs/LAYER1.md) - Technical details of memory storage
|
||||
- [Old Versions](docs/archive/old-versions/) - Previous documentation
|
||||
|
||||
## Development
|
||||
|
||||
@@ -85,6 +157,10 @@ cargo build --release
|
||||
RUST_LOG=debug aigpt server
|
||||
```
|
||||
|
||||
## Design Philosophy
|
||||
|
||||
**"AI evolves, tools don't"** - This tool provides simple, reliable storage while AI (Claude) handles interpretation, evaluation, and analysis. The tool focuses on being maintainable and stable.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user