docs: README rewrite — memory layer positioning, 12 tools, comparison table

[EtanHey]

Summary

• Complete README rewrite: from "conversation indexer" to "persistent memory for AI agents"
• Architecture diagram showing 3-layer stack (Agent → Think/Recall → Knowledge Base)
• Comparison table vs Mem0, Zep/Graphiti, Letta, LangChain Memory
• All 12 MCP tools documented (was 8 — added think, recall, sessions, current_context)
• Shields.io badges (license, Python, MCP tools, tests, chunk count)
• CONTRIBUTING.md with development workflow, code structure, testing guide
• Updated repo description and topics on GitHub

Test plan

• No code changes — docs only
• All links valid (LICENSE, CONTRIBUTING, docs/architecture.md)
• Repo topics and description updated via gh repo edit

🤖 Generated with Claude Code

---

Note

Low Risk
Docs-only changes (README rewrite + new contributing guide) with no runtime or API impact; low risk aside from potential stale/incorrect documentation details.

Overview
Rewrites README.md to reposition BrainLayer as a persistent memory layer for AI agents, adding badges, a new high-level architecture diagram, clearer MCP setup examples (Claude Code/Zed/Cursor), and updated tool documentation that highlights the 12 MCP tools (including brainlayer_think, brainlayer_recall, brainlayer_sessions, and brainlayer_current_context).

Adds a new CONTRIBUTING.md with setup instructions, recommended development workflow, repository structure overview, and unit vs integration test guidance, and updates the README to link to it plus a new comparison section against other memory products.

^{Written by Cursor Bugbot for commit 71a541c. This will update automatically on new commits. Configure here.}

Summary by CodeRabbit

• Documentation
  • Added contribution guidelines for developers
  • Redesigned README with improved organization and visual clarity
  • Added comprehensive comparison table for alternative memory providers
  • Updated quick-start instructions and command examples
  • Enhanced "How It Works" section with workflow diagrams
  • Expanded tool documentation with updated examples

[coderabbitai]

Caution

Review failed

The pull request is closed.

📜 Recent review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db338c1 and 71a541c.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• README.md

---

📝 Walkthrough

Walkthrough

Documentation files have been updated to improve project clarity. A new CONTRIBUTING.md file was added with contribution guidelines, and README.md was substantially restructured to emphasize persistent AI memory, Model Context Protocol integration, and comparisons with alternative memory providers.

Changes

Cohort / File(s)	Summary
Documentation Updates CONTRIBUTING.md, README.md	Added new CONTRIBUTING.md with contribution guidelines (83 lines). Restructured README.md (127 added, 60 removed) to shift focus from features to memory-centric narrative, introducing MCP-driven workflows, tool capabilities, comparison tables with memory providers (Mem0, Zep/Graphiti, Letta, LangChain Memory), and updated CLI examples.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Hoppy hops of docs so bright,
CONTRIBUTING guides the path just right,
README now sings of memory's dance,
MCP workflows, tools all gleaming—
BrainLayer's vision in full gleaming! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/readme-brand

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}