Skip to content

docs: update README for v0.4.0#8

Merged
rohitg00 merged 2 commits intomainfrom
rohit/readme-v0.4.0
Mar 1, 2026
Merged

docs: update README for v0.4.0#8
rohitg00 merged 2 commits intomainfrom
rohit/readme-v0.4.0

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented Feb 28, 2026

Summary

  • Updated all version references from v0.3.0 to v0.4.0
  • Added MCP Resources section (4 resources: status, project profile, project recent, memories latest)
  • Added MCP Prompts section (3 prompts: recall_context, session_handoff, detect_patterns)
  • Added 4 new MCP endpoints (resources list/read, prompts list/get)
  • Documented POST /agentmemory/enrich endpoint and mem::enrich function
  • Added confidence scoring to relationships description
  • Updated stats: 173 tests, 22 functions, 29 REST endpoints, 142KB bundle, ~8,200 LOC
  • Added liveness probe endpoint to API table

Test plan

Summary by CodeRabbit

  • New Features

    • Added MCP resources and prompts (4 resources, 3 prompts) and new REST "enrich" endpoint; expanded viewer/export/list endpoints.
    • Introduced liveness health endpoint and health version bump to v0.4.0.
    • Enhanced memory relationships with confidence scoring and filtering; enriched context injection before tool use.
  • Documentation

    • Updated API docs and samples to reflect expanded endpoints, enrichment capabilities, and revised terminology.

…confidence

Update stats (173 tests, 22 functions, 29 REST + 4 MCP endpoints, 142KB),
add MCP resources/prompts/endpoints sections, document enrich endpoint,
confidence scoring on relationships, and liveness probe.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e303070 and 84bf415.

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

📝 Walkthrough

Walkthrough

README updated to v0.4.0: MCP expanded to include 4 resources and 3 prompts plus tools; REST/API surface expanded (new enrich and MCP resource/prompts endpoints, total endpoints increased to 34); health endpoints/version updated; memory relationships now include confidence scoring and minConfidence filtering; build/docs metrics refreshed.

Changes

Cohort / File(s) Summary
Primary README
README.md
Version bumped to 0.4.0; MCP capabilities expanded (4 resources, 3 prompts, tools + resources + prompts); new REST/API endpoints added (including enrich, MCP resources/prompts, explicit reads for MCP resources/prompts); liveness and health/healthcheck version updated; PreToolUse context now includes enriched context injection; memory relationships now document confidence scores and minConfidence filtering; build/docs/test/bundle metrics updated.
Counts / Manifest
(manifest summary lines changed)
Line counts changed: +49 / -20 reflecting updated documentation and metrics.
Metadata / Terminology
README.md (headings/phrasing)
Terminology and style standardized across sections (e.g., agentmemory wording, endpoint counts, expanded descriptions for enrichment and memory evolution).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A little rabbit hops with cheer,
Docs refreshed and endpoints near,
Resources, prompts, enrichment in tow,
Confidence scores help memories grow —
Hooray for v0.4.0, watch us go! 🎉

🚥 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 title clearly and concisely summarizes the main change: updating the README documentation for version 0.4.0, which matches the PR objectives and the substantial documentation updates shown in the raw summary.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch rohit/readme-v0.4.0

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: 2

🤖 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`:
- Around line 399-406: The fenced code block showing the HTTP endpoints (e.g.,
"GET  /agentmemory/mcp/tools", "POST /agentmemory/mcp/call", "GET 
/agentmemory/mcp/resources", "POST /agentmemory/mcp/resources/read", "GET 
/agentmemory/mcp/prompts", "POST /agentmemory/mcp/prompts/get") should include a
language specifier; update the opening fence from ``` to ```http so the block is
rendered/syntax-highlighted as HTTP/plain text.
- Line 99: Update the README text that currently reads "29 REST endpoints" to
accurately reflect the API count: change it to "34 REST endpoints" or
alternatively clarify the breakdown as "29 core + 5 MCP endpoints" only if that
math is correct—based on the reviewer you should change the three occurrences
mentioned (the phrase near the snippet "Agents without hooks or MCP can
integrate via the 29 REST endpoints directly." and the lines referenced as 99,
117, 472) so they either say "34 REST endpoints" or explicitly state the
breakdown "28 core agentmemory endpoints + 6 MCP endpoints = 34 endpoints" to
match the API table; ensure both the short summary and any parenthetical counts
are updated consistently.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b21ae2 and e303070.

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

Comment thread README.md Outdated
Comment thread README.md Outdated
Update three locations that incorrectly stated 29 endpoints to reflect
the actual 34 endpoints in the API table. Add http language specifier
to MCP endpoints code block.
@rohitg00 rohitg00 merged commit 5c4ef04 into main Mar 1, 2026
1 check passed
@rohitg00 rohitg00 deleted the rohit/readme-v0.4.0 branch March 1, 2026 16:38
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