Skip to content

docs: align website + README with current MCP surface#45

Merged
emp3thy merged 1 commit into
mainfrom
docs/website-readme-alignment
May 6, 2026
Merged

docs: align website + README with current MCP surface#45
emp3thy merged 1 commit into
mainfrom
docs/website-readme-alignment

Conversation

@emp3thy
Copy link
Copy Markdown
Owner

@emp3thy emp3thy commented May 6, 2026

Summary

Reconciles user-facing docs with the code reality after two phases of architectural drift:

  • Synthesis migrated to IDE-driven (Claude Code via memory.synthesize_next_get_context / _apply + better-memory-synthesize skill) — docs still claimed Ollama-driven CONSOLIDATE_MODEL=llama3 LLM pipeline.
  • ~10 MCP tools added in later phases (semantic memory, episode lifecycle, raw-observation drill-down, retention) — README and website/mcp-tools.md listed only the original 6.

Files

  • website/configuration.md — drop dead CONSOLIDATE_MODEL row; scope OLLAMA_HOST to 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 on start_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 --strict passes (no warnings on the edited content).
  • Reviewer spot-check: every tool listed in better_memory/mcp/server.py's _tool_definitions() is now in website/mcp-tools.md and the README table.
  • Reviewer spot-check: no remaining mentions of CONSOLIDATE_MODEL or "Ollama-driven synthesis" anywhere in website/ or README.

Out of scope (follow-up)

  • Drift guard: a feedback-typed memory rule has been recorded in better-memory ("when changing code in better_memory/, validate website/*.md and README.md still match"). Surfaces via memory_retrieve once the session-retrieve hook (separate PR / Track A) lands.

🤖 Generated with Claude Code

…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>
Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

🟢 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.

@emp3thy emp3thy merged commit 1d43837 into main May 6, 2026
1 check passed
@emp3thy emp3thy deleted the docs/website-readme-alignment branch May 6, 2026 18:01
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