LoreDocs

LoreDocs v0.1.33

Your AI project's knowledge base. Organized, searchable, version-tracked.

LoreDocs gives Claude persistent access to your project documentation -- specs, guides, architecture decisions, reference docs -- so it never loses context between sessions. Works with Claude Code, Cowork, Cursor, OpenAI Codex, and Hermes Agent.

Install directly from Claude Code's plugin marketplace, or via PyPI: uvx loredocs

Quick Start

Prerequisites: uv (fast Python package manager).

# Install uv: https://docs.astral.sh/uv/getting-started/installation/

Clone and install

cd /path/to/loredocs uv sync

For detailed installation instructions, see INSTALL.md.

Using the Claude Agent SDK directly? git clone the public repo and point the SDK's local-directory plugin loader at it -- the repo root is a self-contained plugin directory (.claude-plugin/plugin.json + .mcp.json). No separate SDK-installable bundle exists or is needed.

Using LoreDocs

Claude Code (Terminal)

claude --plugin-dir /path/to/loredocs

Or inside an existing session:

/plugin add /path/to/loredocs

Once loaded, Claude has access to all 51 LoreDocs MCP tools automatically. Ask Claude to "create a vault for this project" or "find the architecture doc" and it uses the tools on its own.

Cowork (Desktop App)

1. Click + next to the prompt box
2. Select Plugins > Add plugin
3. Browse to the loredocs source folder

Shared Database Access: Cowork runs in a sandboxed VM. To access docs saved from Claude Code, ask Claude:

"Mount my ~/.loredocs folder"

Hermes Agent

For Hermes Agent users, add LoreDocs as an MCP server under mcp_servers: in ~/.hermes/config.yaml (see INSTALL.md for the full entry), then restart Hermes.

All 51 LoreDocs MCP tools are then available in your Hermes sessions.

Hermes Disclosures

When using LoreDocs with Hermes Agent:

• Installation: First run downloads the loredocs version you pin from PyPI via uvx. There is no automatic self-update.
• Data Storage: All vault data is stored locally at ~/.loredocs/ in SQLite format. No data is sent to cloud services or external servers.
• Pro License Validation: Pro tier activation uses offline Ed25519 cryptography to validate your license key. No network request is made during validation.
• Telemetry: LoreDocs does not collect or transmit telemetry or usage data.
• Network calls: Pro semantic search downloads the BAAI/bge-small-en-v1.5 embedding model from Hugging Face once, on first use. The optional Notion import calls the Notion API with a token you provide. LoreDocs makes no other network calls.

How It Works

LoreDocs organizes knowledge into vaults -- named containers for related documents. Each vault can hold specs, guides, decisions, checklists, or any text you want Claude to remember.

~/.loredocs/loredocs.db          <-- SQLite database (metadata, search index)

~/.loredocs/vaults/ / <-- Document files on disk

Key concepts:

• Vaults group related docs by project or topic
• Documents are text files with metadata (tags, categories, priority, notes)
• Version history tracks every change to every document
• Full-text search via SQLite FTS5 finds anything instantly
• Injection loads vault content into Claude's context on demand

Your Data is Always Available

LoreDocs works through MCP tools when they are available and falls back to bundled scripts automatically when they are not. Your vault documents are safe regardless of MCP status -- the same add, search, and retrieve operations work either way. You do not need to configure anything; the plugin skill handles the switch silently.

Verify Installation

After installing, verify LoreDocs is working by asking Claude:

"Run vault_list and show me the results."

If you see a list of vaults (or an empty list if this is your first time), LoreDocs is connected. If you get an error about missing tools, re-run uv sync and reload the plugin.

Recommended CLAUDE.md Setup

For the best experience, add the following snippet to your ~/.claude/CLAUDE.md (global) or your project's CLAUDE.md. This tells Claude how to use LoreDocs consistently across sessions.

## LoreDocs (persistent project knowledge)

At session start:

1. Call vault_list to see available knowledge vaults.
2. Call vault_inject_summary for any vaults relevant to the current project.
3. Use this context to understand project architecture, decisions, and reference docs.

During the session:

• If you create significant documentation, add it to LoreDocs with vault_add_doc.
• Tag documents for easy cross-vault discovery with vault_tag_doc.

At session end:

• If new docs were created or updated, ensure they are stored in LoreDocs for future sessions.

For Cowork users: Cowork does not run hooks automatically. Add instructions to call vault_list and vault_inject_summary at session start in your project CLAUDE.md.

Canonical Project Knowledge

In multi-agent environments, different tools and agents often create improvised mirrors of shared skill or configuration content -- playbooks, style guides, shared reference docs. Those mirrors drift. One agent updates the source; the other keeps reading the stale copy. Two agents in the same project end up operating from divergent knowledge with no visible signal that anything is wrong.

LoreDocs prevents this by making the vault the single canonical source that every agent reads. Instead of each agent loading a local file copy, every agent calls vault_inject_by_tag at session start and gets the same vault-managed version.

Recommended pattern

Store shared content (playbooks, team guidelines, shared specs) as vault documents rather than as local files that agents copy or mirror.

Agents load the content at session start:

vault_inject_by_tag: team-playbook

All agents -- regardless of surface (Claude Code, Cowork, CLI, or any future AI tool) -- call the same vault and receive the same current version. Updating the content requires editing the vault document once; all agents pick up the change on their next session start.

Local files (.claude/skills/, .agents/, or any surface-specific config) become pointers or bootstrap stubs only -- not the authoritative content. The vault is the source of truth.

Example: sharing a playbook across an agent team

# Session start for any agent on the team:

1. Inject the shared playbook by tag

vault_inject_by_tag("team-playbook")

2. Inject any project-specific reference docs

vault_inject_by_tag("project-architecture")

Working context is now current -- no local file copies needed.

To store the shared content in the vault (one time, or on each update):

# Store (or update) the shared playbook:

vault_update_doc(vault="team-knowledge", doc_id="playbook-id", content=open("PLAYBOOK.md").read())

Or add it fresh (path= reads directly from disk -- no need to load into context):

vault_add_doc(vault="team-knowledge", name="Team Playbook", path="/absolute/path/to/PLAYBOOK.md", tags=["team-playbook"])

Any agent that calls vault_inject_by_tag("team-playbook") reads the same document. No copies, no mirrors, no drift.

Plans: Free vs Pro

LoreDocs is local-first and free to use. Pro ($9/mo) removes the storage limits and unlocks semantic (meaning-based) retrieval. Everything runs on your machine on either plan -- Pro does not add any cloud component.

Upgrade to Pro -- $9/month

After checkout, your license key is emailed automatically to the address you used at checkout, usually within a few minutes. Questions: info@labyrinthanalyticsconsulting.com.

Free tier limits are enforced before writes; Pro removes them. Check your current tier and usage anytime with vault_tier_status. Activate a Pro license with vault_set_tier.

The Pro semantic features use a local embedding model (BGE-small-en-v1.5) and the

LanceDB index -- still no data leaves your machine.

Features

• Vault organization: Group docs by project with linked project metadata
• Document versioning: Full history with rollback to any prior version
• Tagging and categorization: Tag docs for cross-vault discovery
• Priority levels: Mark docs as critical, high, normal, or low priority
• Full-text search: Fast keyword search across all vaults and documents
• Context injection: Load specific docs, tags, or vault summaries into Claude's context
• Bulk operations: Import directories, bulk-tag, export manifests
• Document linking: Connect related docs across vaults
• Embedding-based document relationships (Pro): vault_find_related returns both keyword co-occurrence and embedding-based auto-links for Pro users. Uses BGE-small-en-v1.5, cosine >= 0.75, same-vault scoped. Embedding links are archived if you downgrade from Pro to Free.
• Cross-product session linking (Pro): Automatically links vault documents to the most relevant LoreConvo sessions, and vice versa. Three tools: vault_link_session, vault_get_session_links, vault_get_linked_sessions. Requires both LoreDocs Pro and LoreConvo Pro.
• Tier management: Free/Pro tiers with configurable limits
• Local-first: SQLite database, no cloud dependency, zero API costs

MCP Tools

LoreDocs provides 51 MCP tools by default (52 with the notion extra installed; 52 with LOREDOCS_ENABLE_CAP_TOOLS=1 and the notion extra) organized by function:

Vault Management (8 tools)

Document Operations (10 tools)

Search and Discovery (6 tools)

| vault_find_related | Discover documents related to a given doc (Pro