Installation¶
System Requirements¶
| Component | Minimum | Notes |
|---|---|---|
| Python | 3.11+ | 3.12 recommended |
| RAM | 512 MB | 1 GB+ for large knowledge bases |
| Disk | 200 MB | Base install; data grows with your KB |
| OS | Linux, macOS, Windows (WSL2) | Docker image is linux/amd64 and linux/arm64 |
Sentence Transformers
Lithos downloads a sentence-transformers model (all-MiniLM-L6-v2, ~90 MB) on first run to power semantic search. Subsequent starts use the cached model. No internet connection is required after the first run.
Install Methods¶
Docker is the easiest way to run Lithos — no Python environment management, no dependency conflicts.
Prerequisites: Docker and Docker Compose (v2+)
This starts Lithos on SSE transport at http://localhost:8765/sse.
Data is persisted in a Docker volume (lithos_data). To use a local directory instead:
Then start the server:
uv is the fastest way to install Python packages:
Connect an Agent¶
Once Lithos is running, add it to your agent's MCP config:
Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or the equivalent on your platform:
Restart Claude Desktop. You'll see the Lithos tools in the tool list.
In ~/.openclaw/workspace/config/mcporter.json:
If Lithos is on a different machine:
In Agent Zero's MCP server config (usually in the web UI or mcp_servers.json):
Use host.docker.internal when Agent Zero runs in Docker on the same machine as Lithos.
Verify the Installation¶
You should see:
{
"documents": 0,
"chunks": 0,
"agents": 0,
"active_tasks": 0,
"open_claims": 0,
"tags": 0,
"duplicate_urls": 0
}
Upgrading¶
Pre-1.0 compatibility
Lithos follows a migration safety over API stability policy pre-1.0. MCP tool signatures may change between minor versions, but your on-disk Markdown knowledge is always preserved. Check the Changelog before upgrading.
v0.2.1 breaking changes
lithos_links and lithos_provenance were removed in v0.2.1. Replace them with lithos_related.
Next Steps¶
- Quickstart → — write your first knowledge item and run a search
- Configuration → — tune data directory, search thresholds, and more