Anpigon MCP Server Obsidian Omnisearch

🚀 MCP Server Obsidian Omnisearch

This project is a server based on FastMCP, providing search functionality for Obsidian note libraries through REST API interfaces.

🚀 Quick Start

This project implements a search service that allows you to programmatically search Obsidian notes. It uses FastMCP to expose the search functionality as a tool for integration with other services.

✨ Features

• Search notes in the Obsidian note library.
• Integrate with REST API.
• Return the absolute paths of matching notes.
• Easily integrate with the FastMCP tool.

📦 Installation

Prerequisites

• Python 3.x
• Obsidian and its Omnisearch plugin installed and running
• FastMCP library
• An active Obsidian note library

Steps

1. Clone the repository:

git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
cd mcp-server-obsidian-omnisearch

2. Install dependencies:

uv install

📚 Documentation

Configuration

The path to the Obsidian note library 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 to run the Obsidian Omnisearch community plugin: 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%

{
  "mcpServers": {
    "obsidian-omnisearch": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-server-obsidian-omnisearch",
        "run",
        "mcp-server-obsidian-omnisearch",
        "/path/to/your/obsidian/vault"
      ]
    }
  }
}

{
  "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: Search Obsidian notes and return the absolute paths of matching notes.
• Parameters:
  • query: The search query string.
• Return: A list of absolute paths of matching notes.

Development

Build and Publish

To prepare the distribution package:

1. Synchronize dependencies and update the lock file:

uv sync

2. Build the package distribution:

uv build

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

3. Publish to PyPI:

uv publish

Note: You need to set your PyPI credentials via environment variables or command-line arguments:

• Token: --token or UV_PUBLISH_TOKEN
• Username: --user or UV_PUBLISH_USER
• Password: --password or UV_PUBLISH_PASSWORD

📄 License

No license information provided in the original document, so this section is skipped.

⚠️ Important Note

If you encounter any problems or have other questions during use, please feel free to contact us.