docs: align website + README with current MCP surface#45
Merged
Conversation
…rchitecture Reconciles user-facing docs with the code reality after the synthesis pipeline migrated to IDE-driven (Claude Code via memory.synthesize_next_get_context / _apply MCP split + better-memory-synthesize skill) and ~10 MCP tools were added in later phases. - website/configuration.md: drop dead CONSOLIDATE_MODEL row; scope OLLAMA_HOST to embeddings. - website/architecture.md: rewrite synthesis section as Claude-driven (was Ollama-driven). - website/index.md: accurate tagline; tool table 6 -> 10 with link to full reference. - website/mcp-tools.md: add Semantic memory section (4 tools) + Synthesis section (2 tools). - website/observation-lifecycle.md: fix synthesis trigger description. - README.md: scope Ollama prereq to embeddings; tool table 6 -> 18 grouped by category. mkdocs build --strict passes. No code changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Claude BugBot Analysis
All changes in this PR are documentation-only updates to markdown files (README.md, website/*.md). No executable code was modified, so there are no bugs, logic errors, security vulnerabilities, or other concrete defects to report.
No bugs were detected in this PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reconciles user-facing docs with the code reality after two phases of architectural drift:
memory.synthesize_next_get_context/_apply+better-memory-synthesizeskill) — docs still claimed Ollama-drivenCONSOLIDATE_MODEL=llama3LLM pipeline.website/mcp-tools.mdlisted only the original 6.Files
website/configuration.md— drop deadCONSOLIDATE_MODELrow; scopeOLLAMA_HOSTto embeddings only.website/architecture.md— rewrite the Synthesis pipeline section as IDE-driven via the MCP get/apply split + skill.website/index.md— accurate tagline ("SQLite + local Ollama embeddings. Synthesis runs in your Claude Code session — no separate cloud dependency."); tool table 6 → 10 with link to full reference (18 tools).website/mcp-tools.md— add Semantic memory tools section (4 tools:semantic_observe/_retrieve/_update/_delete) and Synthesis tools section (synthesize_next_get_context/_apply).website/observation-lifecycle.md— fix synthesis trigger description (now Claude-driven via skill, not auto-run onstart_episode).README.md— scope Ollama prereq to embeddings; expand the MCP tools table from 6 → 18 grouped by category (Episodic, Semantic, Episodes, Synthesis, Knowledge, Operations).Test plan
uv run mkdocs build --strictpasses (no warnings on the edited content).better_memory/mcp/server.py's_tool_definitions()is now inwebsite/mcp-tools.mdand the README table.CONSOLIDATE_MODELor "Ollama-driven synthesis" anywhere inwebsite/or README.Out of scope (follow-up)
feedback-typed memory rule has been recorded in better-memory ("when changing code inbetter_memory/, validatewebsite/*.mdand README.md still match"). Surfaces viamemory_retrieveonce the session-retrieve hook (separate PR / Track A) lands.🤖 Generated with Claude Code