mirror of https://github.com/okf-memory/okf-agent-memory.git synced 2026-10-01 18:25:09 +00:00

sknr f6a9c70ff6 docs(release): credit @kurodaritsu and mark Issue #11 closed in v0.5.0 notes		History 2026-10-01 12:37:18 +02:00
..
guides	docs(cli): update CLI and Getting Started guides with scope matrix and --scope flag	2026-10-01 12:09:02 +02:00
project	docs(release): credit @kurodaritsu and mark Issue #11 closed in v0.5.0 notes	2026-10-01 12:37:18 +02:00
releases	docs(release): credit @kurodaritsu and mark Issue #11 closed in v0.5.0 notes	2026-10-01 12:37:18 +02:00
security	docs(security): reframe Jules prompt template for defensive robustness	2026-09-18 09:25:37 +02:00
spec	feat(spec): add Agent Action Grammar (AAG) v0.1 formal RFC specification	2026-09-15 12:58:06 +02:00
README.md	refactor(docs): move release playbook to docs/project/playbooks and deduplicate	2026-09-18 10:23:49 +02:00

README.md

OKF Agent Memory — Documentation Index

Welcome to the comprehensive documentation for OKF Agent Memory (Open Knowledge Format v0.2 persistent project memory for AI agents).

docs/
├── guides/        # Getting started, CLI & MCP reference, agent prompting best practices
├── spec/          # Formal specifications, OKF v0.2 compatibility & architecture RFCs
├── security/      # Security governance, threat modeling & adversarial audit checklists
├── project/       # Project roadmap, release playbook, multi-agent testing & alternatives
└── releases/      # Versioned changelogs & release archive

📚 Documentation Map

1. Guides & References

Getting Started Guide — Comprehensive onboarding guide for agents and humans.
CLI & MCP Reference — Complete command-line arguments, deterministic exit codes, and MCP tool protocols.
Agent Instruction Best Practices — Guide to deterministic, token-efficient instruction design and Agent Action Grammar (AAG).
LLM Instruction Patterns Cheat Sheet — Quick reference for RFC 2119 modals, guard clauses, tables, and anti-patterns.

2. Specifications & RFCs

OKF Agent Memory Convention v0.1 — Behavioral rules, trust tiers, and lifecycle specification.
OKF v0.2 Compatibility Matrix — Strict Open Knowledge Format specification validation analysis.
Dual-Memory Agent Architecture RFC — RFC proposing a 2-layer model: Normative Working Memory (Push) and Semantic Knowledge Memory (Pull).

3. Security & Governance

Security & Privacy Guidelines — Data governance, zero secret leaks, PII protection, and memory poisoning defenses.
Security Audit Checklist — Standardized 4-area security checklist and prompt for dedicated Security Reviewer Agents.

4. Project & Operations

Project Roadmap & Milestones — Phased development plan and future milestones.
Release Playbook — Canonical release procedure, master file inventory, checklist, and notes template.
Multi-Agent Testing & Evaluation — Test scenarios (TC-01 to TC-07), compatibility matrix, and benchmarks.
Alternatives & Ecosystem Comparison — Comparison with Mem0, Letta, and ad-hoc markdown files.

5. Release Notes & History

Release Notes Archive — Versioned changelogs and release notes archive from v0.1.0 to present.