Skip to content

docs: update README for v0.6.1#80

Merged
rohitg00 merged 1 commit intomainfrom
docs/readme-v061
Mar 25, 2026
Merged

docs: update README for v0.6.1#80
rohitg00 merged 1 commit intomainfrom
docs/readme-v061

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented Mar 25, 2026

Summary

  • Punchy two-paragraph technical pitch above the fold (Dan Koe style) with 3-line quick start
  • All stats updated for v0.6.1: 38 MCP tools, 52 functions, 95 endpoints, 573 tests
  • New v0.6.1 features added to capabilities table, comparison table, tools table, and functions list

Test plan

  • README-only change, no code

Summary by CodeRabbit

Documentation

  • Completely revamped README with expanded feature descriptions including memory persistence, searching, and cross-agent behavioral details
  • Documented new citation provenance capabilities for tracing memory sources back to original observations
  • Documented cascading staleness feature for automatic propagation of freshness status across related memories
  • Added documentation for cross-agent synchronization via P2P mesh and memory trust mechanisms

- Add two-paragraph technical pitch above the fold with 3-line quick start
- Update tool count 37→38 (memory_verify), function count 50→52, test count 573
- Add memory_verify to MCP tools table, mem::verify and mem::cascade-update to functions table
- Add citation provenance and cascading staleness to capabilities table
- Add cross-agent sync and memory trust to comparison table
- Update API endpoint count 93→95, version 0.6.0→0.6.1
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 25, 2026

📝 Walkthrough

Walkthrough

README.md documentation update that reorganizes navigation, adds detailed descriptions of memory persistence and cross-agent behavior, expands feature comparison tables with new capabilities (citation provenance, cascading staleness, cross-agent sync, memory trust), and increments version counts and inventory (MCP tools 37→38, API endpoints 93→95, functions 50→52, tests 551→573, health version 0.6.0→0.6.1). New MCP tool memory_verify and functions mem::verify and mem::cascade-update are introduced.

Changes

Cohort / File(s) Summary
Documentation & Inventory Update
README.md
Reorganized Quick Start section ordering; added descriptive content on memory persistence, cross-agent behavior, and retrieval/consolidation pipelines; expanded feature comparison tables with citation provenance, cascading staleness, cross-agent sync, and memory trust; updated numeric counts (MCP tools, API endpoints, functions, tests, health version); introduced new MCP tool memory_verify and functions mem::verify and mem::cascade-update.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hops with glee through docs so bright,
Numbers twinkle, new tools alight!
Provenance traced, staleness flows,
Memory mesh in clever rows,
Thirty-eight tools, fifty-two more—
What wonders wait to explore! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: update README for v0.6.1' accurately describes the main change—a documentation-only update to the README for a new release version.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-v061

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

29-37: Optional copy polish: repeated sentence openings reduce readability.

At Line 29 and Line 31, multiple consecutive sentences begin with the same word (“You” / “Your”). Consider light rewording for rhythm.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 29 - 37, The opening paragraph has several
consecutive sentences starting with the same word (“You” and “Your” around the
description of agentmemory and its benefits); rewrite those sentences in the
README paragraph so the rhythm varies—e.g., convert one or two “You …” sentences
into passive or subject-alternating forms and rephrase a “Your agents…” sentence
to start with the benefit or feature (mentioning agentmemory, CLAUDE.md,
.cursorrules, or the triple-stream retrieval) to break repetition while
preserving meaning and metrics.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 623: The README has inconsistent endpoint counts: the header states "95
endpoints" while the "Supported Agents REST" section states "93 REST endpoints";
update the latter to match the actual count (use the same value as the header,
95) and verify the number against src/api.ts to ensure accuracy, then adjust the
text in the "Supported Agents REST" section (the phrase "93 REST endpoints") so
both places show the same endpoint count.

---

Nitpick comments:
In `@README.md`:
- Around line 29-37: The opening paragraph has several consecutive sentences
starting with the same word (“You” and “Your” around the description of
agentmemory and its benefits); rewrite those sentences in the README paragraph
so the rhythm varies—e.g., convert one or two “You …” sentences into passive or
subject-alternating forms and rephrase a “Your agents…” sentence to start with
the benefit or feature (mentioning agentmemory, CLAUDE.md, .cursorrules, or the
triple-stream retrieval) to break repetition while preserving meaning and
metrics.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f26cbb41-b4b1-429d-89f0-ab0eeae9b6ab

📥 Commits

Reviewing files that changed from the base of the PR and between 005b8c8 and 52d696c.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
## API

93 endpoints on port `3111` (87 core + 6 MCP protocol). Protected endpoints require `Authorization: Bearer <secret>` when `AGENTMEMORY_SECRET` is set. The table below shows a representative subset; see `src/api.ts` for the full endpoint list.
95 endpoints on port `3111` (89 core + 6 MCP protocol). Protected endpoints require `Authorization: Bearer <secret>` when `AGENTMEMORY_SECRET` is set. The table below shows a representative subset; see `src/api.ts` for the full endpoint list.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Endpoint count is still inconsistent across sections.

Line 623 says 95 endpoints, but the Supported Agents REST section still states 93 REST endpoints (Line 148). Please align both to avoid user confusion.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 623, The README has inconsistent endpoint counts: the
header states "95 endpoints" while the "Supported Agents REST" section states
"93 REST endpoints"; update the latter to match the actual count (use the same
value as the header, 95) and verify the number against src/api.ts to ensure
accuracy, then adjust the text in the "Supported Agents REST" section (the
phrase "93 REST endpoints") so both places show the same endpoint count.

@rohitg00 rohitg00 merged commit e5f42c4 into main Mar 25, 2026
1 check passed
@rohitg00 rohitg00 deleted the docs/readme-v061 branch March 25, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant