Skip to main content

MCP server for Obsidian vault structural health checks. Find broken links, orphaned notes, missing frontmatter — and auto-repair them.

Project description

vault-health-mcp

MCP server for Obsidian vault structural health checks.

Find broken wikilinks, orphaned notes, and missing frontmatter — then auto-repair them. Works with any Obsidian vault, no plugins required.

Install

pip install vault-health-mcp

Usage

Claude Code

claude mcp add vault-health -- vault-health-mcp --vault ~/my-vault

Claude Desktop

{
  "mcpServers": {
    "vault-health": {
      "command": "uvx",
      "args": ["vault-health-mcp", "--vault", "/path/to/vault"]
    }
  }
}

MCP Tools

Tool Tier Description
configure_vault Free Point the server at a vault at runtime
check_vault_health Free Full structural scan: broken links, orphans, missing frontmatter
find_orphans Free List all structurally disconnected leaf notes
find_broken_links Free List all wikilinks pointing to non-existent files
vault_statistics Free File count, link count, orphan %, frontmatter coverage
repair_vault Pro Auto-fix safe issues (add-only, never deletes)

How auto-repair works (Pro)

repair_vault only makes additive changes:

  • Broken [[links]] → replaced with plain text (the link text is preserved)
  • Missing frontmatter → adds a default YAML block with title and type

It never deletes files, removes content, or modifies existing frontmatter values.

Pro tier

The free tier detects every category of vault rot. The Pro tier unlocks repair_vault — one call to fix the safe categories automatically.

License activation — any one of these works:

# 1. Environment variable
export VAULT_HEALTH_LICENSE="eyJhbGc..."

# 2. CLI flag
vault-health-mcp --license-key "eyJhbGc..." --vault ~/my-vault

# 3. Config file
echo "eyJhbGc..." > ~/.vault-health-mcp/license.jwt

Licenses are verified fully offline — no phone-home, no activation server. Get a license: [coming soon — Dodo Payments storefront in verification].

Requirements

  • Python 3.10+
  • An Obsidian vault (any size)

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

vault_health_mcp-0.2.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

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

vault_health_mcp-0.2.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file vault_health_mcp-0.2.0.tar.gz.

File metadata

  • Download URL: vault_health_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for vault_health_mcp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a806e4854ff0621c7075966c66f4c3b92c7ded12b6a61ac7f3ba63e129987463
MD5 fb14cbd2acaac99a770a24641314b0c4
BLAKE2b-256 3321fd07d4b97aa73535ee8f90479be3476270291a11268b52e831ba585fe221

See more details on using hashes here.

File details

Details for the file vault_health_mcp-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vault_health_mcp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3324f5c2409b4a7c61919158cc41592dd58fb4270892b2646aea58f59398794
MD5 848a6e67dcd96cd7f98b992155f8d054
BLAKE2b-256 4a904024a579224a5a4acf16c52be2eb9b60702873041a246f7b5f8ac77c34f3

See more details on using hashes here.

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