Skip to content

Document that remember() context must be a directory path #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amanhij merged 1 commit into from
Mar 18, 2026
Merged

Document that remember() context must be a directory path #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions zikkaron/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,12 @@ def _file_hash(filepath: str) -> str | None:

@mcp_server.tool()
def remember(content: str, context: str, tags: list[str]) -> dict:
"""Store a new memory with embedding and optional file hash."""
"""Store a new memory with embedding and optional file hash.

context MUST be the actual working directory path (e.g., '/home/user/projects/myapp'),
NOT a description. get_project_context() filters by directory path match —
descriptive strings will make memories unfindable by project.
"""
storage = _get_storage()
embeddings = _get_embeddings()
buffer = _get_buffer()
Expand Down Expand Up @@ -1248,6 +1253,7 @@ def sync_instructions(claude_md_path: str = "") -> dict:
- NEVER rely on CLAUDE.md or built-in memory for cross-session context — use Zikkaron
- Before starting any task, call `get_project_context` for the current working directory
- After completing any significant task, call `remember` to store what was done, decisions made, and outcomes
- CRITICAL: The `context` parameter in `remember` MUST be the actual working directory path (e.g., `/home/user/projects/myapp`), NEVER a description. `get_project_context` filters by exact directory path match — descriptive strings break it.
- Zikkaron is your brain. Use it.

### Hippocampal Replay — Context Compaction Shield
Expand All @@ -1260,7 +1266,7 @@ def sync_instructions(claude_md_path: str = "") -> dict:
- `restore` returns: checkpoint + anchored memories + hot context + SR predictions + gap detection

### Available Tools
- `remember(content, context, tags)` — Store memory with write gate
- `remember(content, context, tags)` — Store memory with write gate. `context` MUST be a directory path (e.g., `/home/user/projects/myapp`), not a description.
- `recall(query, max_results, min_heat)` — Multi-signal retrieval
- `get_project_context(directory)` — Hot memories for directory
- `checkpoint(directory, ...)` — Snapshot working state
Expand Down
Loading