P

mcp-obsidian-index

...
Created 12/3/2024bytcsavage

Language:

Python

Stars:

5

Forks:

2

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:/// 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  --database  --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  run obsidian-index

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

Last updated: 1/30/2025

Publisher info

tcsavage's avatar

Tom Savage

@signal-ai
London, UK
39
followers
23
following
50
repos

More MCP servers built with Python

MCP Server for Bing Webmaster Tools

An MCP (Model Context Protocol) server that provides access to Bing Webmaster Tools functionality

By isiahw1
usgs-water-mcp

This MCP server provides access to real-time water data from the USGS Water Services API. It allows you to fetch instantaneous water measurements including stream flow, gage height, temperature, and other water quality parameters from thousands of monitoring stations across the United States.

By pgiffy
screeny

Privacy-focused macOS MCP server for secure, user-approved window screenshots

By rohanrav