Skip to main content

Obsidian Index MCP server

An MCP server that provides a semantic search over an Obsidian vault and exposes recent notes as resources.

Components

Resources

The server exposes recently modified notes in your vaults as resources to MCP clients.

  • Notes are addressed by an obsidian://<VAULT_NAME>/<NOTE_PATH> URL scheme
  • Notes have the text/markdown media type

Tools

The server implements one tool:

  • search-notes: Performs semantic search over indexed notes

Run the server

uv run obsidian-index mcp --vault <VAULT_PATH> --database <DATABASE_PATH> --reindex --watch
  • --vault: Path to the Obsidian vault (can be specified multiple times)
  • --database: Path to the local database file (will be created if it doesn't exist)
  • --reindex: Reindex all notes in the vault (you probably want this every time right now)
  • --watch: Watch for changes in the vault and update the index accordingly

Quickstart

Install

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration ``` "mcpServers": { "obsidian-index": { "command": "uv", "args": [ "--directory", "", "run", "obsidian-index", "--database", "", "--vault", "", "--reindex", "--watch" ] } } ```
Published Servers Configuration ``` "mcpServers": { "obsidian-index": { "command": "uvx", "args": [ "obsidian-index", "--database", "", "--vault", "", "--reindex", "--watch" ] } } ```

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory <PATH_TO_PROJECT> run obsidian-index

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Metadata

Release files for iflow-mcp_tcsavage_obsidian-index 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iflow-mcp_tcsavage_obsidian-index 0.1.1
File Size Uploaded
iflow_mcp_tcsavage_obsidian_index-0.1.1.tar.gz 55.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for iflow-mcp_tcsavage_obsidian-index 0.1.1
File Interpreter ABI Platform
iflow_mcp_tcsavage_obsidian_index-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 69.9 kB

Release files / iflow_mcp_tcsavage_obsidian_index-0.1.1.tar.gz

Download URL iflow_mcp_tcsavage_obsidian_index-0.1.1.tar.gz
Size 55.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3dde45cdf6c860d1efe3261cf331e39478a82587160305cdeb512e592fbdb994
BLAKE2b-256 checksum
How to use checksums
ed5a9843305ffdc2d5613e3e9adb6b61c60f56c65fd8db02fc9e0e079523dee8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / iflow_mcp_tcsavage_obsidian_index-0.1.1-py3-none-any.whl

Download URL iflow_mcp_tcsavage_obsidian_index-0.1.1-py3-none-any.whl
Size 14.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2639efc44fb4ea8ba0a7aaefb39b5a91f2fecaf0872cc56b34e8742ca3bde866
BLAKE2b-256 checksum
How to use checksums
4e4575b7e06d48ac31f22b31af776fb8b15e209d4b1c3f275c7b2728a93f2817
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page