Skip to main content

Unified MCP server for AI-assisted development — on-demand Obsidian vault access + worker delegation

Project description

hive-vault

CI codecov PyPI Python 3.12+ Docs License: MIT

Your AI coding assistant forgets everything between sessions. Hive fixes that.

Hive is an MCP server that connects your AI assistant to an Obsidian vault. Instead of loading everything upfront, it queries only what's needed — on demand.

Metric Without Hive With Hive
Context loaded per session ~800 lines (static) ~50 lines (on demand)
Token cost for context 100% every session 6% average per query
Knowledge retained between sessions 0% 100% (in vault)

Measured on a real vault with 19 projects, 200+ files. See benchmarks.

Quick Start

Hive runs without a vault — vault tools return a friendly error until VAULT_PATH is set, so you can install first and configure later.

# Minimal — uses default vault path ~/Projects/knowledge
claude mcp add -s user hive -- uvx --upgrade hive-vault

# With a custom vault path
claude mcp add -s user hive -e VAULT_PATH=$HOME/path/to/vault -- uvx --upgrade hive-vault

# Gemini CLI
gemini mcp add -s user -e VAULT_PATH=$HOME/path/to/vault hive-vault uvx -- --upgrade hive-vault

Default vault path: ~/Projects/knowledge. Override with VAULT_PATH (or HIVE_VAULT_PATH) as shown above.

For Codex CLI, GitHub Copilot, Cursor, Windsurf, and other clients, see Getting Started.

Then ask your assistant: "Use vault_list to see my vault"

Requirements

Hive degrades gracefully — every recommended or optional dependency reveals more capability without breaking the baseline.

  • Required

    • Python 3.12+ (works on 3.13).
    • A directory of markdown files. The vault structure used by 00_meta / 10_projects / 50_work is optional — without it, vault tools still operate but the scope routing is flat.
  • Recommended

    • git initialised inside the vault. Without it, vault_write / vault_patch still write to disk; they just skip the per-write commit (and vault_commit reports the working tree as untracked).
    • The Obsidian desktop app to author the vault by hand.
    • The obsidian-git plugin with auto-commit set to 5–10 minutes. Pair it with vault_write(commit=False) / vault_patch(commit=False) to push the git workload off the synchronous tool path; see Recommended configuration below.
  • Optional

    • Ollama running qwen2.5-coder:7b (or compatible) for local, free delegate_task / capture_lesson worker calls.
    • An OpenRouter API key (OPENROUTER_API_KEY) as a free-tier and paid fallback worker.
    • A backup git remote (e.g. private GitHub repo) so vault history survives a disk loss.

Recommended configuration

Per ADR-006 (commit policy), the recommended pairing for write-heavy flows is:

  1. Install and enable the obsidian-git plugin in your vault.
  2. Set its auto-commit interval to 5 or 10 minutes.
  3. Call vault_write(..., commit=False) and vault_patch(..., commit=False) for all bulk operations.
  4. Optionally call vault_commit(message="...") at the end of a session to force a checkpoint sooner than the obsidian-git tick.

vault_health reports a ## external_committer block when it detects obsidian-git in the vault. The commit=False durability contract is explicit: files are persisted to disk regardless; only the commit is deferred. A crash before the next flush loses the commit, not the content.

When a tool call is cancelled mid-flight (slow worker, client timeout), the server may have already mutated the disk before the cancel ack reaches the wire. vault_health surfaces a ## ghost_responses counter and emits a mcp.ghost_response.suppressed_after_cancel_ack WARNING for each event — verify state via vault_query rather than retrying, since the ErrorData ack does not imply rollback (ADR-007).

Tools

Tool What it does
vault_query Load project context, tasks, roadmap, lessons — or any file by path
vault_search Full-text search with metadata filters, regex, ranked results, recent changes, lesson-usage ranking (rank_by)
vault_list Browse projects and files with glob filtering
vault_health Server identity (version, vault path, backends), health metrics, drift detection, usage stats, opt-in runtime block
vault_write Create, append, or replace vault files. commit=False defers the git commit for batching
vault_patch Surgical find-and-replace. commit=False defers the git commit for batching
vault_commit Flush pending commit=False writes into one git commit
capture_lesson Capture lessons inline / batch-extract from text / look up existing lessons by keyword (find=)
session_briefing Tasks + lessons + git log + health in one call
delegate_task Route tasks to cheaper models or summarize vault files
worker_status Budget, connectivity, available models

Plus 5 resources and 4 prompts for guided workflows.

Lesson reinforcement

Every read of a lesson via vault_query, vault_search, or capture_lesson(find=…) increments a counter and grows that lesson's confidence asymptotically toward 1.0. Validated lessons rank higher than one-shot captures over time.

# Surface the top-ranked lessons matching a keyword
capture_lesson(project="hive", find="multi-process")

# Search lessons ranked by usage signal (not BM25)
vault_search(query="timeout", rank_by="reinforcements")    # most-reinforced first
vault_search(query="timeout", rank_by="confidence")        # highest decayed confidence
vault_search(query="timeout", rank_by="hybrid")            # α=0.7 BM25 + 0.3 confidence

Storage: SQLite side-table at HIVE_LESSON_DB_PATH (default ~/.local/share/hive/lesson_reinforcement.db). WAL mode + busy_timeout make it cross-process safe.

Architecture

MCP Host (Claude Code, Gemini CLI, Codex CLI, Cursor, ...)
    └── hive-vault (MCP server, stdio)
            ├── Vault Tools (7) ── Obsidian vault (Markdown + YAML frontmatter)
            ├── Session Tools (1) ── Adaptive context assembly
            └── Worker Tools (2) ── Ollama (free) → OpenRouter free → paid ($1/mo cap) → reject

Documentation

Full documentation at mlorentedev.github.io/hive:

Project-bound knowledge (docs-as-code) lives in docs/:

Contributing

See CONTRIBUTING.md for setup and PR workflow.

git clone https://github.com/mlorentedev/hive.git && cd hive
make install   # create venv + install deps
make check     # lint + typecheck + test (478 tests, 90% coverage)

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

hive_vault-1.22.0.tar.gz (491.1 kB view details)

Uploaded Source

Built Distribution

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

hive_vault-1.22.0-py3-none-any.whl (90.1 kB view details)

Uploaded Python 3

File details

Details for the file hive_vault-1.22.0.tar.gz.

File metadata

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

File hashes

Hashes for hive_vault-1.22.0.tar.gz
Algorithm Hash digest
SHA256 6bf99f423948fafc1cbea3be88aee38c706c9fc9c65c3ad4e5d7473fa9fcfa64
MD5 0a6c9bfa26d176fa5496e6f8cd60ec40
BLAKE2b-256 29da49691c3c70d62ab3e77f7177b4d89ec12aade091de574a9b340c2930a9b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for hive_vault-1.22.0.tar.gz:

Publisher: release.yml on mlorentedev/hive

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

File details

Details for the file hive_vault-1.22.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for hive_vault-1.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e86825629a32bfa13785d0c8150071933876b49aa583cc3f7ba09b1da500fcc
MD5 9e4a57a6cb14d1f96dd73560fd9218ba
BLAKE2b-256 19ff76549fba61ec624f04c60dc55727ad2ee683bea74c84e7e7b734339d42f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for hive_vault-1.22.0-py3-none-any.whl:

Publisher: release.yml on mlorentedev/hive

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