docs: align examples with current CLI and API#33
Merged
Conversation
Owner
|
Approved for merge. Docs-only change, zero code risk. |
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
This is a docs-only synchronization pass to make the README and docs match the behavior currently exposed by the codebase.
The main goal is to remove stale examples that would fail for users today, while keeping the scope limited to documentation. I intentionally avoided packaging or implementation changes here so this can be reviewed independently from code-behavior PRs.
What changed
Replaced stale REST API references with MCP server documentation
The docs previously described an optional REST API / standalone memory server, including examples such as:
I could not find a current
servercommand in the CLI. The exposed integration path is now the MCP server, so the docs now show:I also added explicit wording that Mnemosyne does not currently expose a standalone REST API server, to avoid implying there is a missing command users should be able to run.
Files touched:
README.mddocs/api-reference.mddocs/architecture.mddocs/hermes-integration.mdCorrected CLI examples for Hindsight imports
The README previously showed Hindsight import examples through the generic Hermes import command with flags such as
--fileand--bank:The current CLI exposes Hindsight import through the standalone command added for that importer:
So the README examples now use that command instead of unsupported Hermes CLI flags.
Corrected API reference drift
Updated
docs/api-reference.mdto match the current Python API surface, including:Mnemosyne(...)constructor arguments (session_id,db_path,bank,author_id,author_type,channel_id)get_context(limit=...)returning recent working-memory dictionaries rather than a formatted query-based stringscratchpad_write(content)scratchpad_read()scratchpad_clear()PROVIDER_REGISTRYtoPROVIDERSI also clarified that
bank=Nonein the module-level helper signatures applies to the module-level convenience functions; instance methods use the bank configured on theMnemosyne(...)instance.Corrected provider count and importer wording
The docs now consistently refer to 7 supported import providers:
I kept the generic Hermes CLI examples to options currently exposed by that CLI. Where provider-specific importer options exist in Python but are not exposed through the generic Hermes command, I added clarifying wording instead of documenting unsupported CLI flags. For example, offline Letta AgentFile import is now mentioned as a Python importer option:
Clarified SQLite storage / backup wording
The README and installation guide previously implied everything lived in a single SQLite file. The current layout can include:
~/.hermes/mnemosyne/data/mnemosyne.db~/.hermes/mnemosyne/data/banks/<name>/triples.dbThe backup example now copies the full Mnemosyne data directory rather than only the top-level
mnemosyne.db.Updated Hermes plugin tool list
docs/hermes-integration.mdnow includes the registered diagnostic tool:mnemosyne_diagnoseWhat this PR intentionally does not change
mcpextra inpyproject.toml.Verification performed
mnemosyne/core/memory.pybefore updating API docs.mnemosyne/core/importers/__init__.py.mnemosyne_diagnose.No whitespace errors were reported.
Review notes
This is meant as PR 1 in a small sequence: