Skip to main content

MCP Server Obsidian Omnisearch

smithery badge A FastMCP-based server that provides Obsidian vault search functionality through a REST API interface.

Overview

This project implements a search service that allows you to search through Obsidian vault notes programmatically. It uses FastMCP to expose the search functionality as a tool that can be integrated with other services.

Features

  • Search through Obsidian vault notes
  • REST API integration
  • Returns absolute paths to matching notes
  • Easy integration with FastMCP tools

Prerequisites

  • Python 3.x
  • Obsidian with Omnisearch plugin installed and running
  • FastMCP library
  • Active Obsidian vault

Installation

Installing via Smithery

To install MCP Server Obsidian Omnisearch for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @anpigon/mcp-server-obsidian-omnisearch --client claude

Manual Installation

  1. Clone the repository:
git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
cd mcp-server-obsidian-omnisearch
  1. Install dependencies:
uv install

Configuration

The Obsidian vault path is now provided as a command line argument when running the server:

python server.py /path/to/your/obsidian/vault

Usage

Obsidian Omnisearch API

You need the Obsidian Omnisearch community plugin running: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine

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-omnisearch": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-server-obsidian-omnisearch",
        "run",
        "mcp-server-obsidian-omnisearch",
        "/path/to/your/obsidian/vault"
      ]
    }
  }
}
Published Servers Configuration
{
  "mcpServers": {
    "obsidian-omnisearch": {
      "command": "uvx",
      "args": [
        "mcp-server-obsidian-omnisearch",
        "/path/to/your/obsidian/vault"
      ]
    }
  }
}

API Reference

Search Notes

  • Function: obsidian_notes_search(query: str)
  • Description: Searches Obsidian notes and returns absolute paths to matching notes
  • Parameters:
    • query: Search query string
  • Returns: List of absolute paths to matching notes

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/mcp-server-obsidian-omnisearch run mcp-server-obsidian-omnisearch

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

You can also watch the server logs with this command:

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-server-obsidian-omnisearch.log

Dependencies

  • FastMCP
  • requests
  • urllib

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Metadata

Release files for mcp-server-obsidian-omnisearch 0.1.2

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

Source distribution (sdist)

Source distribution for mcp-server-obsidian-omnisearch 0.1.2
File Size Uploaded
mcp_server_obsidian_omnisearch-0.1.2.tar.gz 56.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mcp-server-obsidian-omnisearch 0.1.2
File Interpreter ABI Platform
mcp_server_obsidian_omnisearch-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 62.2 kB

Release files / mcp_server_obsidian_omnisearch-0.1.2.tar.gz

Download URL mcp_server_obsidian_omnisearch-0.1.2.tar.gz
Size 56.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c1604d7e4ff846a6d00a3379bda123dc87f7c4e97a450fcfec431b83776b7670
BLAKE2b-256 checksum
How to use checksums
52eda43588a10808c960e03a51f617d17633666c24af695d061fc5c8f322f254
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.12

Release files / mcp_server_obsidian_omnisearch-0.1.2-py3-none-any.whl

Download URL mcp_server_obsidian_omnisearch-0.1.2-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6ddb5e21436612ca056008cf183822029cabd8a9289b16bcfdea577e42b15c93
BLAKE2b-256 checksum
How to use checksums
52b2f75368da494ad2681b4a52e27e242208947f7b641ad0f971740a413460f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.12

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

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