You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,11 @@
17
17
18
18
---
19
19
20
-
Mnemosyne indexes your codebase into a local SQLite store, scores every chunk with a 6-signal hybrid retriever, compresses results with AST awareness, and returns exactly what you need within a token or result budget. It runs entirely locally -- no API keys, no cloud, no runtime dependencies beyond Python 3.11+.
20
+
<palign="center">
21
+
<imgsrc="https://raw.githubusercontent.com/castnettech/mnemosyne/main/docs/assets/diagrams/mnemosyne-ecosystem.gif"alt="Mnemosyne Ecosystem -- three packages, zero cloud"width="800">
22
+
</p>
23
+
24
+
Mnemosyne indexes your codebase and documents into a local SQLite store, scores every chunk with a 6-signal hybrid retriever, compresses results with AST awareness, and returns exactly what you need within a token or result budget. Supports source code (Python, JS/TS, Go, Rust, C#, Java, Kotlin), documents (PDF, DOCX, CSV, plaintext), and database schemas (SQL DDL, JSON snapshots, SQLite introspection). It runs entirely locally -- no API keys, no cloud, no runtime dependencies beyond Python 3.11+.
-**Document ingestion** -- PDF, DOCX, CSV, and plaintext extraction into an isolated document partition with independent BM25 + TF-IDF retrieval. Optional `mnemosyne-engine[pdf]` extra for PDF support
62
+
-**Schema ingestion** -- DDL files, JSON/YAML snapshots, and live SQLite introspection indexed alongside code for cross-domain queries
57
63
-**Daemon mode** -- JSON-RPC over Unix socket keeps indexes warm for sub-20ms queries
58
64
-**Full audit trail** -- append-only JSON-lines log of every operation
59
65
-**Zero runtime dependencies** -- pure Python 3.11+ stdlib. One `pip install`, no conflicts
@@ -121,8 +127,10 @@ Works with any agent that can execute shell commands.
121
127
|---|---|
122
128
|`init`| Create workspace and config |
123
129
|`ingest`| Index files (incremental, `--full` to rebuild) |
124
-
|`query`| Search with token budget |
130
+
|`query`| Search with token budget (`--docs`, `--all` for document partition) |
Copy file name to clipboardExpand all lines: mcp/README.md
+32-7Lines changed: 32 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# mnemosyne-mcp
2
2
3
-
MCP server for [Mnemosyne](https://github.com/castnettech/mnemosyne-engine) -- a 6-signal hybrid code retrieval engine that reduces LLM context waste by 73%.
3
+
MCP server for [Mnemosyne](https://github.com/castnettech/mnemosyne) -- a 6-signal hybrid retrieval engine for code, documents, and database schemas. Reduces LLM context waste by 73%.
4
4
5
5
For the full reference, see [MCP.md](../MCP.md) in the repository root.
6
6
@@ -31,33 +31,58 @@ Or add to your project's `.mcp.json`:
31
31
32
32
## Tools
33
33
34
-
### `mnemosyne.search`
34
+
### `search`
35
35
36
-
Search a codebase using 6-signal hybrid retrieval (BM25 + TF-IDF + symbol matching + usage frequency + predictive prefetch + optional dense embeddings) fused via Reciprocal Rank Fusion. Returns the most relevant code chunks within a configurable token budget, with AST-aware compression.
36
+
Federated search across code and document partitions. Code results use 6-signal hybrid retrieval (BM25, TF-IDF, symbol matching, usage frequency, predictive prefetch, optional dense embeddings) fused via Reciprocal Rank Fusion. Document results use BM25 + TF-IDF with isolated vocabulary. Returns labeled sections so the LLM can perform cross-type ranking.
37
37
38
38
**Parameters:**
39
39
-`query` (string, required) -- natural language or keyword query
40
40
-`budget` (integer, default 8000) -- maximum token budget
41
41
-`project_root` (string, optional) -- path to project root
42
42
43
-
### `mnemosyne.index`
43
+
### `search_docs`
44
44
45
-
Index or re-index a codebase. Incremental by default (only processes changed files).
45
+
Search the document partition only (PDFs, DOCX, CSVs, logs, and other non-code files). Uses BM25 and TF-IDF with an isolated vocabulary tuned for prose retrieval.
46
+
47
+
**Parameters:**
48
+
-`query` (string, required) -- natural language query
49
+
-`budget` (integer, default 8000) -- maximum token budget
50
+
-`project_root` (string, optional) -- path to project root
51
+
52
+
### `index`
53
+
54
+
Index or re-index a codebase. Incremental by default (only processes changed files). Indexes both code and document partitions.
46
55
47
56
**Parameters:**
48
57
-`project_root` (string, optional) -- path to project root
49
58
-`full` (boolean, default false) -- force full re-index
50
59
51
-
### `mnemosyne.stats`
60
+
### `stats`
52
61
53
62
Show index statistics: file count, chunk count, tokens, language breakdown, chunk types.
54
63
55
64
**Parameters:**
56
65
-`project_root` (string, optional) -- path to project root
57
66
67
+
### `schema_ingest`
68
+
69
+
Ingest database schema into the index. Accepts DDL files (.sql), JSON/YAML schema snapshots, or SQLite database paths for live introspection.
70
+
71
+
**Parameters:**
72
+
-`source_path` (string, required) -- path to schema source
73
+
-`environment` (string, optional) -- tag for the schema source (e.g., "production", "staging")
74
+
-`project_root` (string, optional) -- path to project root
75
+
76
+
### `schema_stats`
77
+
78
+
Report indexed schema sources and statistics.
79
+
80
+
**Parameters:**
81
+
-`project_root` (string, optional) -- path to project root
82
+
58
83
## How it works
59
84
60
-
Mnemosyne indexes your codebase into local SQLite, scoring every chunk with six retrieval signals fused through Reciprocal Rank Fusion. AST-aware compression then strips boilerplate while preserving function signatures, control flow, and documentation -- delivering exactly within your token budget.
85
+
Mnemosyne indexes your codebase and documents into local SQLite, scoring every chunk with retrieval signals fused through Reciprocal Rank Fusion. Code gets 6-signal hybrid search; documents get BM25 + TF-IDF with isolated vocabulary. AST-aware compression strips boilerplate while preserving function signatures, control flow, and documentation.
61
86
62
87
Zero runtime dependencies beyond Python 3.11+. No API keys. No cloud services. Everything runs locally.
0 commit comments