Mnemolis

A unified local knowledge search API for self-hosted homelabs. Mnemolis runs as a Docker container on your internal network and routes queries to the appropriate backend — offline knowledge, weather forecast, RSS news, live web search, service monitoring, or multiple sources concurrently — via a single endpoint.

Exposes both a REST API and an MCP server so any client can connect to it.

This README covers what it is, installation, and the API reference. For deep-dive mechanism detail, exact scoring weights, and the real bugs found and fixed along the way, see the Wiki.

Why Mnemolis

A homelab accumulates real, distinct sources of truth — your own RSS feeds, an offline encyclopedia, weather, service uptime, Home Assistant state — but each one normally needs its own query language, its own client, its own mental context switch. Mnemolis exists so you can ask one plain-language question and not have to know in advance which backend actually has the answer, or query three of them yourself when the real answer spans more than one. It runs entirely on your own infrastructure — Open-Meteo is the one deliberate exception — so asking it something never means sending your query, your home's state, or your reading habits to a third party.

Sources

Source	Backend	Description
kiwix	Kiwix	Offline knowledge base — Wikipedia, Stack Exchange, iFixit, FreeCodeCamp, DevDocs
forecast	Open-Meteo	3-day weather forecast, no API key required
news	FreshRSS	Recent articles from your RSS feeds via GReader API
web	SearXNG	Live web search via your local SearXNG instance
uptime	Uptime Kuma	Service monitor status — reports any down services
ha	Home Assistant	Entity state summaries — lights, locks, sensors, motion, batteries, power
changes	Snapshot Engine	Detected changes since last snapshot — outages, weather shifts, new headlines
fusion	—	Query multiple sources concurrently and merge results
auto	—	Mnemolis detects intent and picks the best source

Integrations

Client	Protocol	How
Open WebUI	REST	Lightweight tool that POSTs to /search
Mnemolis Intents	REST	Native HA LLM API integration
Any MCP client (Claude Desktop, Cursor, etc.)	MCP/Streamable HTTP	Connect to http://your-host:8888/mcp

MCP

Mnemolis exposes an MCP server via Streamable HTTP at /mcp on the same port as the REST API. (Previously SSE at /mcp/sse — migrated since SSE is being superseded across the MCP ecosystem. See the wiki's MCP Server page for the full reasoning and a real bug found and fixed during the migration.)

Connecting Claude Desktop

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "mnemolis": {
      "url": "http://your-host-ip:8888/mcp"
    }
  }
}

Connecting any MCP client

Streamable HTTP endpoint: http://your-host-ip:8888/mcp

The MCP server exposes a single search tool with the same interface as the REST API, including fusion_sources support.

Requirements

• Docker + Docker Compose
• A Docker network for container communication (default: mnemo-net)
• One or more of the supported backends running and reachable on the same network

Quick Start

Full stack (recommended)

The repo includes an example compose file and SearXNG config to get all services running together:

git clone https://github.com/immortalbob/Mnemolis
cd Mnemolis

# Create the shared network if it doesn't exist
docker network create mnemo-net

# Copy and edit the example compose file
cp docker-compose.example.yml docker-compose.yml
# Fill in credentials, your coordinates, and secret_key in searxng/settings.yml

docker compose up -d

What's not in the full stack

The example compose intentionally excludes Home Assistant, your LLM backend, and Uptime Kuma — these are typically long-running services with their own existing setup.

If you're running any of these in Docker and want them reachable by Mnemolis, connect them to mnemo-net:

docker network connect mnemo-net ollama
docker network connect mnemo-net homeassistant

Mnemolis only

If you already have the backends running:

git clone https://github.com/immortalbob/Mnemolis
cd Mnemolis
# Edit docker-compose.yml with your settings
docker compose up -d

Hit http://your-host:8888/health to confirm it's running. Full API docs at http://your-host:8888/docs.

Configuration

All settings are passed as environment variables in docker-compose.yml:

Variable	Description	Default
KIWIX_URL	Kiwix container URL	http://kiwix:8080
FRESHRSS_URL	FreshRSS container URL	http://freshrss
FRESHRSS_USER	FreshRSS username
FRESHRSS_API_PASSWORD	FreshRSS API password
FRESHRSS_MAX_ARTICLES	Max articles to fetch	10
SEARXNG_URL	SearXNG container URL	http://searxng:8080
SEARXNG_REQUEST_TIMEOUT_SECONDS	How long Mnemolis itself waits for a SearXNG response — separate from SearXNG's own server-side request_timeout. Set this to match or exceed whatever you've configured on the SearXNG side, or the documented SearXNG timeout fix won't fully take effect	15
WEB_NEWS_RAW_RESULT_BUDGET	How many raw, unscored results to pull from each web search before confidence-aware scoring filters them down — the scoring pipeline's input budget, distinct from WEB_NEWS_TOP_N's output cap below	25
QUERY_EXPANSION_MIN_WORDS	Minimum query length (in words) for web search query expansion to trigger	3
KIWIX_ARTICLE_MAX_CHARS	How many characters of a fetched Kiwix article to keep before scoring/fusion sees it — distinct from FUSION_MAX_CHARS_PER_SOURCE, which truncates the already-combined multi-source response	3000
KIWIX_MULTI_BOOK_FUSION_THRESHOLD_PCT	A second book's best result must score at least this fraction of the leading book's top score to be included in a multi-book fusion response. Lower for more aggressive fusion, raise for more conservative	0.5
SNAPSHOT_STALE_GRACE_MULTIPLIER	How many multiples of a job's own expected interval can pass before /health flags it as "stale" rather than "ok"	3
ROUTING_CACHE_TTL_SECONDS	How long a routing decision (source, Kiwix book, disambiguation candidates) stays cached before the LLM gets asked again	3600
CACHE_TTL_KIWIX_SECONDS	Result cache TTL for kiwix	86400
CACHE_TTL_FORECAST_SECONDS	Result cache TTL for forecast	1800
CACHE_TTL_NEWS_SECONDS	Result cache TTL for news	900
CACHE_TTL_WEB_SECONDS	Result cache TTL for web	3600
CACHE_TTL_UPTIME_SECONDS	Result cache TTL for uptime	60
CACHE_TTL_HA_SECONDS	Result cache TTL for ha	30
CACHE_TTL_CHANGES_SECONDS	Result cache TTL for changes	120
CACHE_TTL_FUSION_SECONDS	Result cache TTL for fusion	1800
FORECAST_LATITUDE	Forecast location latitude — required for forecast to work at all; leaving it unset correctly reports forecast as not configured rather than returning weather for the wrong place	(unset)
FORECAST_LONGITUDE	Forecast location longitude — same requirement as above	(unset)
FORECAST_LOCATION_NAME	Human-readable location name	(blank)
FORECAST_TIMEZONE	Timezone for forecast times	UTC
UPTIME_KUMA_URL	Uptime Kuma URL	(blank — disables uptime source)
UPTIME_KUMA_USERNAME	Uptime Kuma username
UPTIME_KUMA_PASSWORD	Uptime Kuma password
HA_URL	Home Assistant URL	(blank — disables HA source)
HA_TOKEN	Home Assistant long-lived access token
LLM_URL	LLM backend URL for intelligent routing	(blank — disables LLM routing)
LLM_MODEL	Model to use for source and book selection	qwen3:8b
LLM_API_TYPE	API format: ollama or openai	ollama
MORNING_START_HOUR	Reference hour (0-23, local time) for resolving "this morning" in changes queries	6
WORK_START_HOUR	Reference hour (0-23, local time) for resolving "while at work" in changes queries	9
API_KEYS	Comma-separated list of valid API keys. Protects POST /search and GET /changes.	(blank — auth disabled)
FORECAST_PRECIP_THRESHOLD_PCT	Precipitation probability (%) above which the forecast mentions rain chance	20
FORECAST_WIND_THRESHOLD_MPH	Wind speed (mph) above which the forecast mentions wind	15
FORECAST_TEMP_CHANGE_THRESHOLD	Temperature shift (°) between snapshots that counts as a meaningful weather change	5.0
BATTERY_LOW_THRESHOLD_PCT	Battery level (%) below which a snapshot diff reports "low"	20.0
FUSION_MAX_SOURCES	Maximum number of sources allowed in a single fusion query	4
FUSION_MAX_CHARS_PER_SOURCE	Characters per source result before truncation in fusion output	1500
FUSION_TIMEOUT_SECONDS	Maximum time to wait for any single source in a fusion query	15
CACHE_MAX_SIZE	Maximum result cache entries before oldest-eviction kicks in	500
ROUTING_CACHE_MAX_SIZE	Maximum routing cache entries before oldest-eviction kicks in	1000
KIWIX_SEARCH_LIMIT	Results requested per book per Kiwix search — higher values help the scoring function find the right answer among brand-name collisions	15
KIWIX_MAX_BOOKS	Maximum number of Kiwix books the LLM can select for a single query — raise for broader multi-book fusion	2
WEB_NEWS_SCORE_THRESHOLD	Web/news results scoring at or below this are dropped as irrelevant	0
WEB_NEWS_TOP_N	Maximum web/news results kept after scoring	10
LOG_LEVEL	Application log level (DEBUG, INFO, WARNING, ERROR) — INFO shows decomposition splits, disambiguation candidates, and article selection decisions	INFO

FreshRSS API setup

1. Enable API access: Administration → Authentication → Allow API access
2. Set an API password: Profile → API password
3. Use that password for FRESHRSS_API_PASSWORD (it's separate from your login password)

SearXNG JSON format

Mnemolis queries SearXNG's JSON API. The included searxng/settings.yml already has this enabled. If you're using an existing SearXNG instance, make sure json is in your formats list:

search:
  formats:
    - html
    - json

Also generate a unique secret_key in searxng/settings.yml:

openssl rand -hex 32

SearXNG request timeout

SearXNG's default request_timeout (3.0s) is too short for several real, commonly-used engines, which can take 15-25+ seconds to respond under normal conditions. If you see "Error reaching SearXNG: connection failed", raise it in your SearXNG settings.yml:

outgoing:
  request_timeout: 10.0
  max_request_timeout: 20.0

Restart SearXNG after changing this. If the error persists after the change, verify SearXNG actually picked it up — a correctly-edited config file doesn't help if the container was never restarted. Full story, including how this was diagnosed: The SearXNG Timeout Lesson.

Also raise SEARXNG_REQUEST_TIMEOUT_SECONDS on the Mnemolis side to match or exceed whatever you set above. Mnemolis has its own, separate client-side timeout for calling SearXNG (default 15) — if it's shorter than SearXNG's own max_request_timeout, Mnemolis will cut the connection first regardless of how generously SearXNG itself is configured to wait.

LLM-assisted routing

Mnemolis uses a local LLM backend in five ways:

1. Source selection — when auto is used and no keyword matches, the LLM picks the best source based on the query, returning multiple sources for complex multi-topic queries to trigger fusion automatically. Also biases toward including Kiwix for "everyone's talking about X"-style discourse framing — see Routing.
2. Book selection — once routed to Kiwix, the LLM picks the best books from your catalog for the query, up to KIWIX_MAX_BOOKS (default 2)
3. Search term disambiguation — for short, definitional Kiwix queries (e.g. "what is a galaxy"), the LLM generates 3 candidate disambiguation terms to break brand-name/homonym collisions. Each candidate is actually searched and scored against real Kiwix results rather than trusting a single guess — see Kiwix Internal Flow.
4. Fusion source selection — when fusion is used without specifying sources, the LLM picks the best 2-3 sources for the query
5. Web query expansion — for web searches of 3+ words, the LLM generates one alternate phrasing so SearXNG is queried twice and results merged, scored against your original query — see Confidence-aware fusion

Auto-fusion escalation — source="auto" now detects multi-topic queries at the keyword level too. If a query matches triggers from multiple sources (e.g. "weather" + "services up"), fusion is triggered automatically without an LLM call.

Routing decisions (including disambiguation candidates and alternate phrasings) are cached for 1 hour so repeated queries skip the LLM call entirely.

Query decomposition and conditional detection (see Query Decomposition and Conditional Query Detection above) are deliberately pure pattern matching with no LLM involvement at all — they need to run on every single query before any LLM call happens at all, including when no LLM is configured.

Supported backends via LLM_API_TYPE:

• ollama — Ollama native API (default)
• openai — OpenAI-compatible API (llama-server, LM Studio, etc.)

The book list is built dynamically from your Kiwix catalog at startup. To force a refresh after adding ZIMs:

curl -X POST http://your-host:8888/catalog/refresh

If LLM_URL is left blank, Mnemolis falls back to keyword-based routing and Wikipedia for all Kiwix queries.

Timezone configuration

Set TZ in docker-compose.yml to your local timezone (e.g. America/New_York). Without it, the container defaults to UTC, which causes time-window phrases in changes queries ("this morning," "while at work") to be calculated against the wrong reference time — off by your UTC offset.

environment:
  TZ: "America/New_York"

This same TZ value is also used by LOCAL_TIMEZONE, a setting that converts stored UTC timestamps (every database timestamp in Mnemolis is UTC internally) into real local time for any feature that needs to bucket activity by local hour-of-day or day-of-week — set TZ once and both get the correct timezone for free. If you specifically want that conversion to use a different zone than TZ, set LOCAL_TIMEZONE explicitly; it always takes priority over TZ:

environment:
  TZ: "America/New_York"
  LOCAL_TIMEZONE: "America/Los_Angeles"   # only if you want these to differ

Most deployments should only ever need to set TZ.

API key authentication (optional)

By default, Mnemolis has no authentication at all — anyone who can reach it on your network can query it, with no key required. This matches the trust model of a homelab where Mnemolis sits behind your own firewall and isn't reachable from the open internet. If Mnemolis is ever exposed beyond a fully trusted local network — a VPN with split tunneling, a reverse proxy, a port forward — set API_KEYS before doing so, not after.

To require an API key for POST /search and GET /changes:

environment:
  API_KEYS: "your-secret-key-here"

Multiple keys are supported, comma-separated:

environment:
  API_KEYS: "key-for-open-webui,key-for-claude-desktop"

Clients must send the key in the X-API-Key header:

curl -X POST http://your-host:8888/search \
  -H "X-API-Key: your-secret-key-here" \
  -H "Content-Type: application/json" \
  -d '{"query": "what is nitrogen", "source": "kiwix"}'

Setting API_KEYS only protects POST /search and GET /changes — every other endpoint stays unauthenticated regardless of this setting, including /health, /cache, /logs, /backup, and /areas. This is intentional, not an oversight: it keeps monitoring tools and discovery requests from being blocked, but it means API_KEYS is not a substitute for actual network-level access control if any of that other data (query logs, cache contents, a full backup of Mnemolis's state) would be sensitive in your specific deployment.

Home Assistant setup

Generate a long-lived access token in Home Assistant:

1. Go to your Profile (click your username in the sidebar)
2. Scroll to Long-lived access tokens
3. Click Create Token, give it a name, copy the token
4. Set HA_URL to your HA instance URL (e.g. http://192.168.1.100:8123)
5. Set HA_TOKEN to the generated token

The ha source handles analytical queries that go beyond HA's built-in single-entity intent handling:

• "house status summary" — lights, locks, sensors, motion, batteries
• "indoor air quality" — CO2, temperature, humidity from indoor sensors
• "security status" — locks, doors, recent motion with time-ago
• "battery status" — all device battery levels
• "outdoor conditions" — weather station sensors
• "how much power am I using" — current and historical consumption

The ha source also participates in fusion — "house status and what's the weather" automatically fuses ha + forecast.

Architecture

Voice Assistant Flow

ESP32 Voice Assistant
          │
          ▼
   Home Assistant
          │
          ▼
 Mnemolis Intents
          │
          ▼
     Mnemolis
          │
          ├────────────────────┐
          │                    │
          ▼                    ▼
      LLM Backend         Source Providers
          │               ├─ Kiwix
          │               ├─ FreshRSS
          ▼               ├─ SearXNG
   Smart Routing          ├─ Open-Meteo
   ├─ Single source       ├─ Uptime Kuma
   ├─ Auto-fusion         ├─ Home Assistant
   └─ Decomposition  ────►└─ Snapshot Engine (changes)
          │
          ▼
      Response
          │
          ▼
 Home Assistant TTS
          │
          ▼
      ESP32

Multi-Client Architecture

   Open WebUI    Claude Desktop    Cursor    Home Assistant
       │                │             │     (Mnemolis Intents)
    REST API            MCP          MCP          REST API
       │                │             │               │
       └────────────────┴─────────────┴───────────────┘
                                │
                                ▼
                           Mnemolis
                                │
                          Smart Routing
        ┌───────────────┬───────────────┬───────────────┐
        ▼               ▼               ▼               ▼
  Single Source    Auto-Fusion    Decomposition   Conditional
 (keyword or LLM) (multi-keyword  (conjunction      Detection
                       /LLM)         split)      ("if X, Y")
        │               │               │               │
        └───────────────┴───────────────┴───────────────┘
                                │
                           ┌────┴────┐
                           ▼         ▼
                    REST API   MCP/Streamable HTTP
                           │         │
               Home Assistant    Any MCP
             (Mnemolis Intents)   Client
                           │
                    Voice Pipeline

Snapshot Engine

              Background Scheduler (APScheduler)
                            │
        ┌──────────┬────────┬───────────┐
        ▼          ▼        ▼           ▼
     Uptime     Forecast   News         HA
     (2 min)    (30 min)  (60 min)    (5 min)
        │          │        │           │
        └──────────┴────────┴───────────┘
                          │
                          ▼
                  Store snapshot
              (SQLite, JSON for HA)
                          │
              Retain history scaled per source
              (more frequent sources keep more
               rows, so every source covers
               at least a full week)
                          │
                          ▼
              Diff consecutive snapshots
        ┌──────────┬────────┬───────────┐
        ▼          ▼        ▼           ▼
    Outages/    Temp/      New        Lock/door/
    Recovery    Precip   headlines     battery
   (net change) changes               changes
   (configurable thresholds)
        └──────────┴────────┴───────────┘
                          │
                          ▼
              GET /changes?hours=N
           source="changes" (auto-routed)
                          │
                          ▼
                Formatted summary
             "what changed today?"

Full mechanics, including why outage/weather changes are collapsed to net change while news/HA events are reported individually: Snapshot Engine & Changes.

Source Fusion

   source="auto"                    source="fusion"
        │                                 │
        ▼                                 ▼
 Keyword scan all sources      LLM picks 2-3 sources
 Multiple match? → fuse        (or you specify explicitly)
 Single match? → direct              │
        │                            │
        └────────────┬───────────────┘
                     │
         ┌───────────┼───────────┐
         ▼           ▼           ▼
       Kiwix        HA        Forecast
      FreshRSS   SearXNG      Uptime
    (any combination of available sources,
         queried concurrently)
         │           │           │
         └───────────┴───────────┘
                     │
        Filter empty / failed results
        web/news results scored + ranked
        (app/scoring.py — keyword overlap,
         generic-result penalty, recency)
        Partial failure OK — best effort
                     │
   Merge with [SOURCE — DESCRIPTION] headers
   (descriptive label prevents cross-source
    inference, e.g. weather ≠ news location)
                     │
               Single Response

Fusion queries all specified sources concurrently, filters empty or failed results, and merges the remainder with descriptive source attribution headers (e.g. [FORECAST — WEATHER FORECAST FOR YOUR CONFIGURED HOME LOCATION]) so the LLM reading the fused response can't mistakenly infer facts across unrelated sections. If only one source returns results, it is returned directly without headers. Full mechanics: Fusion.

Query Decomposition

   source="auto"
        │
        ▼
 Nosplit check
 "compare", "vs", "between", etc.
        │
        ▼
 Try every conjunction type
 "and", "also", "plus", "as well as"
 (not just the first one found —
  keep whichever split produces
  the most genuine sub-intents)
        │
        ▼
 Each candidate sub-query must contain
 either a recognized intent word/noun
 OR a colloquial phrase anywhere in it
 ("what's the deal with X",
  "what's up with X", etc.)
        │
   ┌────┴────┐
   ▼         ▼
Single    Multiple
intent    intents
   │         │
   │    ┌────┴────────────┐
   │    ▼                 ▼
   │  Sub-query 1    Sub-query 2
   │    │                 │
   │  Route            Route
   │  independently    independently
   │    │                 │
   │    └────────┬────────┘
   │             │
   │    Same source? → Merge headers
   │    Different?  → Keep separate
   │    Resolved to internal fusion?
   │      → Pass through unwrapped
   │        (already self-headered)
   │             │
   └─────────────┤
                 ▼
          Single Response
     with [SOURCE — DESCRIPTION] attribution

Decomposition only applies to source="auto". It handles casual, colloquial phrasing the same as formal phrasing, protects bare proper-noun pairs ("Iran and Israel") from being mistaken for two separate intents, and biases discourse-framing queries ("everyone keeps talking about X") toward including Kiwix rather than letting them route past it entirely. Full mechanics, including the real bugs found and fixed in this logic: Query Decomposition and The Proper-Noun-Pair Saga.

Conditional Query Detection

   "if X, Y" / "should X, Y" / "in case X, Y"
                    │
                    ▼
   Leading-comma pattern match
   (deliberately narrow — see below)
                    │
            ┌───────┴───────┐
            ▼               ▼
        No match          Match
            │               │
    Route normally    Extract condition, consequence,
    (decomposition,        and any remainder text
     conditional check          │
     re-applied to        Search ONLY the condition
     each sub-query)            │
            │           Source a structured,
            │           binary signal?
            │         (ha / uptime / forecast-rain)
            │               │
            │       ┌───────┴───────┐
            │       ▼               ▼
            │      No              Yes
            │       │               │
            │  Present real    State explicit verdict
            │  result, note    ("It IS/IS NOT the
            │  it's conditional    case that X...")
            │       │               │
            │       └───────┬───────┘
            │               ▼
            │      Remainder present?
            │       (real intent that
            │        followed the
            │        conditional)
            │               │
            │       ┌───────┴───────┐
            │       ▼               ▼
            │      No              Yes
            │       │               │
            │   Return         Search remainder
            │   framed         independently,
            │   response       merge into response
            └───────┬───────────────┘
                    ▼
              Final Response

Detection is deliberately narrow — only a leading "if X, Y" / "should X, Y" / "in case X, Y" form with an explicit comma is recognized, since "if" is genuinely ambiguous in English and this form sidesteps that ambiguity entirely. Mnemolis has no reminder or trigger capability, so the response is framed honestly around the condition's real answer rather than pretending to act on the consequence — a genuine verdict for structured sources (HA locks, uptime, forecast rain), an honest "you'll need to judge" for everything else. Full design rationale and the real recursion bug found while building this: Conditional Query Detection and The Recursion Design Bug.

Kiwix Internal Flow

              query
                │
                ▼
       LLM picks 1-2 books
     (or Wikipedia-first fallback
        if LLM not configured)
                │
                ▼
   Definitional query? Single word?
   Wikipedia selected? LLM configured?
                │
        ┌───────┴───────┐
        ▼               ▼
       No              Yes
        │               │
        │      Ask LLM for 3 candidate
        │      disambiguation terms
        │      (broad field / specific
        │       synonym / bare word)
        │               │
        └───────┬───────┘
                ▼
   Search each book × each candidate
   term, merge results, dedupe by URL
                │
                ▼
        Score every result
     against the ORIGINAL query
   (exact match, stemmed title/excerpt
    overlap, Wikipedia bonus, list penalty)
                │
                ▼
   2+ books scoring within 50% of
   the leading book's top result?
                │
        ┌───────┴───────┐
        ▼               ▼
       No              Yes
        │               │
  Return single    Fuse best result per
  best-scoring     book — multi-book
  article           fusion response

This is the layer that fixed the "galaxy returns Samsung phones, battery returns military fortifications" problem — rather than trusting one LLM guess about which search term will work, Mnemolis tries several candidates and verifies against real Kiwix results, scored the same way regardless of which term found them. Full mechanics and exact scoring weights: Kiwix Disambiguation and Kiwix Scoring.

REST API

POST /search

Single source:

{
  "query": "what is molybdenum",
  "source": "auto"
}

Fusion — LLM picks sources automatically:

{
  "query": "what is happening with the space program lately",
  "source": "fusion"
}

Fusion — explicit source list:

{
  "query": "what is happening with the space program lately",
  "source": "fusion",
  "fusion_sources": ["kiwix", "web", "news"]
}

Response:

{
  "query": "what is molybdenum",
  "source_used": "kiwix",
  "result": "# Molybdenum\nSource: wikipedia_en_all_maxi_2026-02\n\n...",
  "success": true,
  "cached": false,
  "error": null
}

GET /sources

Returns the list of available sources.

GET /health

Returns status, number of Kiwix books loaded, result and routing cache entry counts alongside their configured max sizes (so growth toward either bound is visible without digging through logs or code), background snapshot job health (each job's status compared against its expected interval — ok, stale, never_ran, or unknown, since every snapshot job already catches its own exceptions and silently logs a warning rather than surfacing failure anywhere externally visible), and connectivity status for every configured source — these are real, live network checks against each dependency, not just a check that a config value is present.

GET /catalog

Lists all books currently loaded from the Kiwix OPDS catalog.

POST /catalog/refresh

Forces a re-scan of the Kiwix catalog without restarting the container.

GET /cache

Shows all current result cache entries with age and remaining TTL.

POST /cache/clear

Clears all result cache entries from memory and disk.

GET /cache/routing

Shows all current routing cache entries — source and Kiwix book selection decisions cached to avoid redundant LLM calls. Bounded at ROUTING_CACHE_MAX_SIZE (default 1000), evicting the oldest entry once full.

POST /cache/routing/clear

Clears all routing cache entries from memory and disk.

GET /backup

Downloads a tarball of all Mnemolis data — result cache, routing cache, query log, and snapshot history. See Backup & Restore below.

GET /backup/info

Shows file sizes and last-modified times for each data file without creating a backup.

GET /areas

Lists all detected Home Assistant areas with entity counts and matching natural-language aliases.

GET /changes

Returns meaningful changes detected across snapshot sources within the last N hours. Optional ?hours=N parameter (default 24). Detects service outages and recoveries, forecast temperature shifts above FORECAST_TEMP_CHANGE_THRESHOLD (default 5°), precipitation changes, and new news headlines.

POST /snapshots/trigger

Manually trigger all snapshot jobs immediately.

GET /logs

Returns recent query log entries — timestamp, query, source requested, source used, cached flag, success, latency in milliseconds, and whether a FALLBACK_CHAIN fallback occurred (e.g. a kiwix request that resolved to web). Optional ?limit=N parameter (default 50, clamped to 1-1000).

POST /logs/clear

Clears all query log entries.

GET /logs/stats

Returns query log statistics — Time To First Knowledge (TTFK), cache hit rate, success rate, fallback count and rate, average latency by source, top 10 most-asked queries, unique query count, and learned query count. Fallback stats are reported per fallback target rather than per original source, since multiple sources can share one target — see Health & Observability for the field-by-field detail.

Caching

Results are cached in memory and persisted to disk, with per-source TTLs:

Source	TTL
kiwix	24 hours
web	1 hour
fusion	30 minutes
forecast	30 minutes
news	15 minutes
uptime	1 minute
ha	30 seconds

Routing decisions are cached separately for 1 hour. Both caches are size-bounded (CACHE_MAX_SIZE, ROUTING_CACHE_MAX_SIZE) with oldest-entry eviction. Full mechanics, including why the two caches exist separately and a real gap found and fixed in routing cache bounding, are in the wiki: Caching.

Kiwix ZIM files

Download ZIM files from library.kiwix.org and place them in ./data/kiwix/. The example compose mounts this directory into the Kiwix container automatically.

Popular ZIMs for a homelab stack:

• wikipedia_en_all_maxi — full English Wikipedia
• unix.stackexchange.com_en_all — Unix & Linux Stack Exchange
• raspberrypi.stackexchange.com_en_all — Raspberry Pi Stack Exchange
• ifixit_en_all — iFixit repair guides
• freecodecamp_en_all — FreeCodeCamp
• devdocs_en_python — Python DevDocs

Multi-book fusion

When a query genuinely spans multiple books — "python raspberry pi gpio setup" touching both Python and Raspberry Pi Stack Exchange — Mnemolis merges results from more than one book instead of returning only the single highest-scoring article. Raise KIWIX_MAX_BOOKS (default 2) for broader multi-book fusion. Full mechanics: Multi-Book Fusion.

Confidence-aware fusion (web & news)

Web (SearXNG) and news (FreshRSS) results are scored against the query and filtered before being returned — not trusted at face value just because they came back. For web search specifically, longer queries also get a second, differently-phrased search merged in. Full scoring weights and the query-expansion mechanism: Confidence-Aware Fusion and Query Expansion.

Adding a New Source

1. Create app/sources/your_source.py with a search(query: str) -> str function
2. Add any config vars to app/config.py and docker-compose.yml
3. Import and register it in app/router.py — add to SOURCE_MAP, INTENT_MAP, SOURCE_DESCRIPTIONS, and CACHE_TTL
4. Optionally add an entry to FALLBACK_CHAIN if your source should fall back to another (e.g. kiwix falls back to web) when it returns nothing useful — this is tracked and surfaced in /health and /logs/stats, so a source with a real, well-matched fallback target gets the same visibility as the built-in ones
5. Rebuild: docker compose up -d --build

Why registration is explicit rather than auto-discovered, and what a new source does/doesn't inherit automatically: Adding a New Source.

The new source is automatically available via both REST and MCP — and immediately fusable with any other source.

Backup & Restore

All Mnemolis state — result cache, routing cache, query log, snapshot history, adversarial self-testing history, and temporal pattern detection history — lives in six files under /app/data, backed by the mnemolis_data Docker volume (see the volume naming note below for how Docker Compose actually names it).

Backing up

curl -o mnemolis-backup.tar.gz http://your-host:8888/backup

Check what would be included first:

curl -s http://your-host:8888/backup/info | python3 -m json.tool

Automate it with cron:

0 3 * * * curl -s -o /path/to/backups/mnemolis-$(date +\%Y\%m\%d).tar.gz http://your-host:8888/backup

A note on volume naming

Docker Compose automatically prefixes named volumes with your project name — the folder docker-compose.yml lives in, by default. A volume named mnemolis_data in the YAML doesn't necessarily get created with that exact name; check first:

docker volume ls | grep data
# or, for a running container:
docker inspect mnemolis --format '{{json .Mounts}}' | python3 -m json.tool

Use the exact name Docker reports in any manual docker run -v command. Set COMPOSE_PROJECT_NAME in a .env file for a stable, predictable prefix regardless of folder name:

echo "COMPOSE_PROJECT_NAME=mnemolis" > .env

Restoring

# Stop the container
docker compose down

# Extract the backup into the data volume
docker run --rm -v mnemolis_data:/app/data -v $(pwd):/backup alpine \
  sh -c "cd /app/data && tar xzf /backup/mnemolis-backup.tar.gz"

# Restart
docker compose up -d

What's NOT in the backup

Kiwix ZIM files, your docker-compose.yml configuration, and searxng/settings.yml are not included — back those up separately as part of your normal homelab backup routine. The /backup endpoint only covers Mnemolis's own state: caches, logs, and snapshot history.

Running Tests

docker exec mnemolis python3 -m pytest /app/tests/ -v

For load testing:

pip install locust
locust -f tests/locustfile.py --host http://your-host:8888

See BENCHMARKS.md for documented results.

1161 tests across every source module, the routing/decomposition/conditional-detection pipeline, caching, adversarial self-testing, cross-source temporal pattern detection, timezone conversion, and the FastAPI/MCP endpoints — see the test file list under Project Structure below for what each file actually covers, or the Contributing page for what a good test for this project looks like.

Project Structure

Mnemolis/
├── Dockerfile
├── docker-compose.yml              # your config (not committed)
├── docker-compose.example.yml      # full stack example
├── requirements.txt
├── pytest.ini
├── CHANGELOG.md
├── BENCHMARKS.md
├── mnemolis_tool.py                # Open WebUI bridge tool
├── README.md
├── searxng/
│   └── settings.yml               # SearXNG config with JSON enabled
├── tests/
│   ├── conftest.py                 # autouse fixture isolating router.py's shared in-memory caches between tests
│   ├── test_router.py              # intent detection, cache, decomposition, conditional detection, time-window resolution, read-only query_log.db access
│   ├── test_routing_cache.py       # routing cache logic and corruption handling
│   ├── test_cache_persistence.py   # cache eviction, disk persistence, .corrupt recovery
│   ├── test_config.py              # settings defaults and env isolation
│   ├── test_timeutil.py            # UTC-to-local-time conversion, DST handling, timezone setting resolution
│   ├── test_kiwix.py               # scoring, stemming, search term cleaning, discourse-framing phrase stripping (pure logic)
│   ├── test_kiwix_network.py       # catalog parsing, book selection, disambiguation, multi-book fusion
│   ├── test_freshrss.py            # general query detection, recency bonus
│   ├── test_freshrss_network.py    # FreshRSS network calls via mocking
│   ├── test_forecast.py            # forecast parsing, location attribution, configurable thresholds
│   ├── test_searxng.py             # SearXNG search, query expansion, scoring integration
│   ├── test_scoring.py             # shared web/news relevance scoring, generic-result penalty, URL normalization
│   ├── test_query_expansion.py     # alternate phrasing generation and sanity checks
│   ├── test_uptime_kuma.py         # Uptime Kuma status parsing via mocking
│   ├── test_fusion.py              # fusion merging, truncation, deduplication, header formatting
│   ├── test_home_assistant.py      # HA entity filtering, area detection, the core matching engine
│   ├── test_main.py                # FastAPI endpoint tests, API key auth, catalog/areas endpoints
│   ├── test_llm.py                 # Ollama/OpenAI-compatible LLM client behavior
│   ├── test_mcp_server.py          # MCP tool schema and call dispatch
│   ├── test_snapshots.py           # snapshot diff engines, net-change collapsing, background job health
│   ├── test_snapshot_jobs.py       # scheduled snapshot job functions
│   ├── test_adversarial_testing.py # combinatorial query generation, structural anomaly checks, flagged-combination review
│   ├── test_temporal_patterns.py   # structured event extraction, non-overlapping occurrence counting, Bonferroni-corrected mining, out-of-sample validation
│   ├── test_security.py            # SQL injection, path traversal, fuzz, concurrency
│   ├── test_property.py            # Hypothesis property-based fuzz testing
│   └── locustfile.py               # Locust load testing suite
└── app/
    ├── main.py                     # FastAPI app + MCP mount + cache/catalog/areas endpoints + API key auth
    ├── snapshots.py                # Snapshot engine — scheduler, diff logic, change detection, background job health reporting
    ├── adversarial_testing.py      # Adversarial self-testing — combinatorial query generation, structural anomaly detection
    ├── temporal_patterns.py        # Cross-source temporal pattern detection — event extraction, Bonferroni-corrected mining, out-of-sample validation
    ├── timeutil.py                 # UTC-to-local-time conversion, shared groundwork for time-of-day-aware features
    ├── mcp_server.py               # MCP server (Streamable HTTP transport)
    ├── router.py                   # Intent detection, source routing, decomposition, conditional detection, caching, read-only query_log.db access
    ├── llm.py                      # LLM client — Ollama native and OpenAI-compatible
    ├── scoring.py                  # Shared relevance scoring for web/news — keyword overlap, generic-result penalty
    ├── query_expansion.py          # Alternate query phrasing for web search multi-query expansion
    ├── config.py                   # Settings via environment variables
    └── sources/
        ├── kiwix.py                # Offline knowledge base — catalog, disambiguation, multi-book fusion, discourse-framing phrase stripping
        ├── forecast.py             # Open-Meteo weather forecast
        ├── freshrss.py             # FreshRSS RSS reader with confidence-aware scoring
        ├── searxng.py              # SearXNG web search with multi-query expansion
        ├── uptime_kuma.py          # Uptime Kuma service monitoring
        ├── home_assistant.py       # Home Assistant entity state summaries, area awareness
        └── fusion.py               # Multi-source concurrent fusion with descriptive headers

Philosophy

Local-first, privacy-preserving, subscription-free. Mnemolis is designed for homelabs where the data stays home. Open-Meteo is the only external network call — every other source (Kiwix, FreshRSS, SearXNG, Uptime Kuma, Home Assistant) runs on your own infrastructure. More on what this project is and isn't: About Mnemolis.

Contributing

PRs welcome. New source modules are the easiest contribution — drop a file in sources/, register it in the router, done. The new source is immediately available via REST, MCP, and fusion with no additional work.

Proposed modules

Looking for contributors interested in building out additional sources:

• Jellyfin — search local media library by title, genre, or actor
• Paperless-ngx — search scanned documents and OCR'd content
• Mealie — search self-hosted recipe library
• Grocy — query pantry inventory, shopping list, or expiring items
• Calibre — search local ebook library
• Navidrome — search self-hosted music library by artist, album, or track
• Immich — search local photo library by date, album, or description

Each source only needs a single search(query: str) -> str function. See any existing file in app/sources/ as a reference.

Part of the Mnemo-net stack

• Mnemolis Intents — native Home Assistant LLM integration for Mnemolis
• Mnemovox-T7S3 — ESP32-S3 voice satellite with CO2, temperature, and humidity sensing

License

MIT — see LICENSE