Skip to main content

Knowledge management MCP server for AI projects - search, tag, version, and organize your project knowledge

Project description

LoreDocs v0.1.4

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 and Cowork.

Available on the Anthropic Marketplace. Install directly from Claude, or via PyPI: uvx loredocs

Quick Start

Prerequisites: uv (fast Python package manager).

# Install uv (one time)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and install
cd /path/to/loredocs
uv sync

For detailed installation instructions (including Cowork plugin setup), see INSTALL.md.

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 39 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"

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/<vault-id>/   <-- 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.

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
  • Tier management: Free/Pro/Team tiers with configurable limits
  • Local-first: SQLite database, no cloud dependency, zero API costs

MCP Tools

LoreDocs provides 39 MCP tools organized by function:

Vault Management (8 tools)

Tool What it does
vault_create Create a new vault with name and description
vault_list List all vaults with doc counts and sizes
vault_info Get detailed vault information
vault_archive Archive a vault (preserves data, hides from listing)
vault_delete Permanently delete a vault and all its documents
vault_link_project Link a vault to a project directory
vault_open_workspace Open or create the vault scoped to a directory path
loredocs_onboard Set up workspace with starter vaults on first install

Document Operations (9 tools)

Tool What it does
vault_add_doc Add a new document to a vault
vault_update_doc Update document content (creates version history)
vault_remove_doc Remove a document from a vault
vault_get_doc Retrieve a document with full content
vault_list_docs List documents in a vault with filtering and sorting
vault_copy_doc Copy a document to another vault
vault_move_doc Move a document to another vault
vault_doc_history View version history of a document
vault_doc_restore Restore a document to a previous version

Search and Discovery (5 tools)

Tool What it does
vault_search Full-text search across all vaults
vault_search_by_tag Find documents by tag across all vaults
vault_find_related Discover documents related to a given doc (Pro only)
vault_suggest Proactive suggestions for relevant docs to load
vault_rebuild_index Rebuild the LanceDB semantic search index (Pro only; run once after installing Pro deps)

Organization (5 tools)

Tool What it does
vault_tag_doc Add tags to a document
vault_bulk_tag Tag multiple documents at once
vault_categorize Set document category (spec, guide, decision, etc.)
vault_set_priority Set document priority level
vault_add_note Add a note or annotation to a document

Context Injection (4 tools)

Tool What it does
vault_inject Load specific documents into Claude's context
vault_inject_by_tag Load all documents matching a tag
vault_inject_summary Load a vault summary with doc titles and descriptions
vault_prime Pre-load vault context into current session (convenience wrapper for vault_inject_summary)

Import/Export (3 tools)

Tool What it does
vault_import_dir Import a directory of files into a vault
vault_export Export a document to a file on disk
vault_export_manifest Export vault metadata as a JSON manifest

Document Links (2 tools)

Tool What it does
vault_link_doc Create a link between two documents
vault_unlink_doc Remove a link between documents

Administration (3 tools)

Tool What it does
vault_tier_status Check current tier limits and usage
vault_set_tier Set the active tier (free, pro, team)
get_license_tier Check current tier and license key status

Portable Project Workspace

LoreDocs and LoreConvo together form a portable project workspace for all of Claude -- session memory AND structured knowledge, entirely on your machine.

  • LoreConvo remembers what you discussed, decided, and left open (episodic + semantic memory)
  • LoreDocs stores the reference docs, specs, and guides Claude needs (durable knowledge)

Where cloud AI workspaces tie you to one ecosystem, LoreConvo + LoreDocs works across every Claude surface you already use -- Code, Cowork, and Chat. Both store data locally in SQLite. Neither sends anything to an external server.

Requirements

  • Python 3.10+
  • macOS or Linux
  • uv package manager
  • mcp and pydantic (auto-installed by uv sync)

Data and Privacy

LoreDocs is local-first. All data lives in ~/.loredocs/ on your machine.

  • Data collected: Document names, content, tags, categories, and vault names you provide when storing documents. No telemetry, usage analytics, or identifiers are collected automatically.
  • Storage: SQLite database at ~/.loredocs/loredocs.db; document files in ~/.loredocs/vaults/. No cloud storage. Override the root directory with the LOREDOCS_ROOT environment variable.
  • Third-party sharing: None. Data never leaves your machine.
  • Retention: Data is retained until you delete it via vault_remove_doc, vault_delete, or remove the database files manually. No automatic expiry.
  • Contact: info@labyrinthanalyticsconsulting.com

Full privacy policy: https://labyrinthanalyticsconsulting.com/privacy

Troubleshooting

MCP tools not showing up in Claude Code? Make sure you ran uv sync first. The virtual environment must exist with dependencies installed.

"No module named 'mcp'" error? The .mcp.json points to the virtual environment's Python. If you moved the folder, re-run uv sync.

Cowork can't see docs saved in Code? Ask Claude to "mount my ~/.loredocs folder" so Cowork can access the shared database.

Fallback Script (Direct DB Access)

If the MCP server is unreachable (e.g., in scheduled tasks or automation scripts), scripts/query_loredocs.py provides the same core operations directly against the SQLite database.

# List all vaults
python scripts/query_loredocs.py --list

# Show vault details and document manifest
python scripts/query_loredocs.py --info "My Project Docs"

# Search documents across all vaults
python scripts/query_loredocs.py --search "architecture"

# Add a document to a vault
python scripts/query_loredocs.py --add-doc \
    --vault "My Project Docs" \
    --name "Architecture Overview" \
    --file docs/architecture.md \
    --tags '["architecture", "design"]'

# Add a document from stdin
echo "# Quick Note" | python scripts/query_loredocs.py --add-doc \
    --vault "My Project Docs" \
    --name "Quick Note" \
    --stdin

The script auto-discovers the database at ~/.loredocs/loredocs.db (or pass --db-path explicitly). It writes the same schema as the MCP tools, including FTS indexing and on-disk file storage.

License

Business Source License 1.1 (BSL 1.1) - Labyrinth Analytics Consulting

Free for personal/non-commercial use (up to 3 vaults). Commercial use requires a paid license. Converts to Apache 2.0 on 2030-03-31. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loredocs-0.1.6.tar.gz (58.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loredocs-0.1.6-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

Details for the file loredocs-0.1.6.tar.gz.

File metadata

  • Download URL: loredocs-0.1.6.tar.gz
  • Upload date:
  • Size: 58.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for loredocs-0.1.6.tar.gz
Algorithm Hash digest
SHA256 d5a61f286d90a9f44352a33c9de7c3ebb8caeeba8f3c8dcc42acfdc742f2976e
MD5 6a694d0a299c84c6c0c2f43155e08b27
BLAKE2b-256 3b146d02a8ffb31415f3c0b17909bab1cc188b0d27637b0a7098ffcf017b0275

See more details on using hashes here.

Provenance

The following attestation bundles were made for loredocs-0.1.6.tar.gz:

Publisher: publish.yml on labyrinth-analytics/loredocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file loredocs-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: loredocs-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 56.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for loredocs-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9deea34d3a3ea5a1b4540ab848597297b364eb7a9f60eae5e6172c4e659da1f6
MD5 b227ad09d2f980c8af46c75eeaa95363
BLAKE2b-256 8d2c9795faea68b3e038cfbb8faee5afeb530fc48db070283d2e5e8d408b5236

See more details on using hashes here.

Provenance

The following attestation bundles were made for loredocs-0.1.6-py3-none-any.whl:

Publisher: publish.yml on labyrinth-analytics/loredocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page