Skip to main content

DuckVault-MCP: Obsidian-DuckDB RAG System with MCP Server

Project description

DuckVault-MCP

DuckVault-MCP is an MCP (Model Context Protocol) server that provides a RAG (Retrieval-Augmented Generation) system for your Obsidian Vault using DuckDB and vector search.

Features

  • Local Vector Search: Uses sentence-transformers (intfloat/multilingual-e5-small) for local embeddings.
  • Incremental Indexing: Uses MD5 hashing to only update modified files.
  • Real-time Monitoring: Uses watchdog to index changes as you edit your notes.
  • Fast Search: Leverages DuckDB with the vss extension and HNSW indexing for millisecond-level retrieval.
  • MCP Compatible: Works seamlessly with AI agents like Claude Code or Cursor.

Installation

# Using uv (recommended)
uv tool install mcp-duckvault

# From GitHub directly
uv tool install git+https://github.com/caron14/mcp-obsidian-duckdb.git

# From PyPI (once published)
pip install mcp-duckvault

Usage

Start the MCP server by pointing it to your Obsidian Vault:

duckvault /path/to/your/obsidian/vault

Options

  • --db-path: Path to the DuckDB file (default: vault.db).
  • --sync-only: Perform a full sync of the vault and exit.
  • -v, --verbose: Enable verbose logging.

Excluding Files (.vaultignore)

To exclude specific files or directories from being indexed, create a .vaultignore file in the root of your Obsidian Vault. The syntax is similar to .gitignore.

By default, .obsidian and .trash are always excluded.

Example .vaultignore:

# Exclude specific folders
private/
drafts/

# Exclude specific file types
*.tmp
*.log

MCP Tools

The server exposes the following tools to AI agents:

  1. search_notes(query: str, tag: Optional[str] = None): Search for relevant notes using natural language.
  2. list_recent_notes(days: int = 7): List notes that were recently updated.

License

MIT

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

mcp_duckvault-0.1.0.tar.gz (106.8 kB view details)

Uploaded Source

Built Distribution

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

mcp_duckvault-0.1.0-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_duckvault-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for mcp_duckvault-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e45e1c5189112ea6839a4c29695f45dd1917575128553dd31f876c839405519e
MD5 04fd6701a67f958e27e450eef5185d5b
BLAKE2b-256 fe548d4d3a2bf655b02fa16f3db5551e742a65d44113d085f7696463185ed961

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_duckvault-0.1.0.tar.gz:

Publisher: pypi-publish.yml on caron14/mcp-duckvault

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

File details

Details for the file mcp_duckvault-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for mcp_duckvault-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c024cace4356551a0eb7059c24f451c8e90c9ce89be0559e67384455cdf306c9
MD5 a615e9569b15ec4ab63f7fc1933036ce
BLAKE2b-256 72edbb7567846f79a98b356a154b3b50c84da6cf6bc960ebc5fd79c6f160df97

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_duckvault-0.1.0-py3-none-any.whl:

Publisher: pypi-publish.yml on caron14/mcp-duckvault

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