Skip to main content

An MCP server that provides a semantic search over an Obsidian vault

Project description

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.

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

iflow_mcp_tcsavage_obsidian_index-0.1.0.tar.gz (54.5 kB view details)

Uploaded Source

Built Distribution

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

File details

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

File metadata

  • Download URL: iflow_mcp_tcsavage_obsidian_index-0.1.0.tar.gz
  • Upload date:
  • Size: 54.5 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for iflow_mcp_tcsavage_obsidian_index-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7b52718f12a31e4e7bb7e81457125f3b21496fcc926f5dac2539cf4d6f639e11
MD5 4ffb5d50536324dfbe767238b85fa1db
BLAKE2b-256 374e4703c73721cb2b140390c5ee7c714c7f5515bd38106123601ef00ae582e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iflow_mcp_tcsavage_obsidian_index-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for iflow_mcp_tcsavage_obsidian_index-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6187206496801c0d3604c7697db061f747ca175494878484bb6f4d97c942d90
MD5 89aa156056ad9c949c5d154a4374bc59
BLAKE2b-256 d9b0510a0896e36dfc7247a349f93da2c3dc395e45638f151a3bce12ab0029a4

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