docs: add CLAUDE.md + mission/principles to AGENTS.md (#720)

* docs: add CLAUDE.md + mission/principles to AGENTS.md Add project mission, design principles, and contribution guidelines to CLAUDE.md (new file) and prepend them to AGENTS.md. Six non-negotiable principles: verbatim always, incremental only, entity-first, local-first zero API, performance budgets, privacy by architecture. * docs: update CLAUDE.md with Milla's edits, add MISSION.md, symlink AGENTS.md CLAUDE.md: - Add Zettelkasten + AAAK explanation to mission (Milla's edit) - Add 7th principle: background everything - Update project structure to match current develop (all modules) - Fix hooks listing to match actual public repo - Add backends/ to structure and key files MISSION.md: - Milla's personal narrative on why MemPalace exists - Origin story, AAAK inside joke, v4 goals AGENTS.md: - Now symlinks to CLAUDE.md (single source of truth) * docs: trim MISSION.md — remove v4 notes and workflow (moved to private)
2026-04-12 15:28:01 -07:00
parent 87e8bafad8
commit 8efd4e53b5
3 changed files with 168 additions and 78 deletions
@@ -1,78 +0,0 @@
-# AGENTS.md
-
-> How to build, test, and contribute to MemPalace.
-
-## Setup
-
-```bash
-pip install -e ".[dev]"
-```
-
-## Commands
-
-```bash
-# Run tests
-python -m pytest tests/ -v --ignore=tests/benchmarks
-
-# Run tests with coverage
-python -m pytest tests/ -v --ignore=tests/benchmarks --cov=mempalace --cov-report=term-missing
-
-# Lint
-ruff check .
-
-# Format
-ruff format .
-
-# Format check (CI mode)
-ruff format --check .
-```
-
-## Project structure
-
-```
-mempalace/
-├── mcp_server.py        # MCP server — all read/write tools
-├── miner.py             # Project file miner
-├── convo_miner.py       # Conversation transcript miner
-├── searcher.py          # Semantic search
-├── knowledge_graph.py   # Temporal entity-relationship graph (SQLite)
-├── palace.py            # Shared palace operations (ChromaDB access)
-├── config.py            # Configuration + input validation
-├── normalize.py         # Transcript format detection + normalization
-├── cli.py               # CLI dispatcher
-├── dialect.py           # AAAK compression dialect
-├── palace_graph.py      # Room traversal + cross-wing tunnels
-├── hooks_cli.py         # Hook system for auto-save
-└── version.py           # Single source of truth for version
-```
-
-## Conventions
-
- **Python style**: snake_case for functions/variables, PascalCase for classes
- **Linter**: ruff with E/F/W rules
- **Formatter**: ruff format, double quotes
- **Commits**: conventional commits (`fix:`, `feat:`, `test:`, `docs:`, `ci:`)
- **Tests**: `tests/test_*.py`, fixtures in `tests/conftest.py`
- **Coverage**: 85% threshold (80% on Windows due to ChromaDB file lock cleanup)
-
-## Architecture
-
-```
-User → CLI / MCP Server → ChromaDB (vector store) + SQLite (knowledge graph)
-
-Palace structure:
-  WING (person/project)
-    └── ROOM (topic)
-          └── DRAWER (verbatim text chunk)
-
-Knowledge Graph:
-  ENTITY → PREDICATE → ENTITY (with valid_from / valid_to dates)
-```
-
-## Key files for common tasks
-
- **Adding an MCP tool**: `mempalace/mcp_server.py` — add handler function + TOOLS dict entry
- **Changing search**: `mempalace/searcher.py`
- **Modifying mining**: `mempalace/miner.py` (project files) or `mempalace/convo_miner.py` (transcripts)
- **Input validation**: `mempalace/config.py` — `sanitize_name()` / `sanitize_content()`
- **Tests**: mirror source structure in `tests/test_<module>.py`
@@ -0,0 +1 @@
+CLAUDE.md