MCP Server Obsidian Omnisearch

by MCP-Mirror

307 downloads

Not rated

GitHub

About

MCP Server Obsidian Omnisearch is a FastMCP-based server that exposes Obsidian vault search functionality through a REST API. It lets you programmatically search notes in your Obsidian vault using the Omnisearch plugin, returning absolute file paths of matching notes.

Details

Author: MCP-Mirror
Downloads: 307
Categories: Knowledge Base, Search

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name MCP Server Obsidian Omnisearch

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

From the repository

Install dependencies with uv install, then run the server by passing your vault path as a command‑line argument (e.g., python server.py /path/to/your/obsidian/vault). Configure it as an MCP tool in Claude Desktop using the provided claude_desktop_config.json snippet.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "mcp server obsidian omnisearch": {
            "anpigon_mcp-server-obsidian-omnisearch": {
                "command": "python",
                "args": [
                    "server.py",
                    "/path/to/your/obsidian/vault"
                ]
            }
        }
    }
}

McpServers

{
    "anpigon_mcp-server-obsidian-omnisearch": {
        "command": "python",
        "args": [
            "server.py",
            "/path/to/your/obsidian/vault"
        ]
    }
}

MCP Server Obsidian Omnisearch

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

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

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

<details>
<summary>Development/Unpublished Servers Configuration</summary>

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

</details>

<details>
<summary>Published Servers Configuration</summary>

{
  "mcpServers": {
    "obsidian-omnisearch": {
      "command": "uvx",
      "args": [
        "mcp-server-obsidian-omnisearch",
        "/path/to/your/obsidian/vault"
      ]
    }
  }
}

</details>

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

2. Build package distributions:

uv build

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

3. 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.

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

MCP Server Obsidian Omnisearch

Overview

Features

Prerequisites

Installation

Configuration

Usage

Obsidian Omnisearch API

Claude Desktop

API Reference

Search Notes

Development

Building and Publishing

Debugging

Dependencies

License

Contributing

Install

More like this

Aws Kb Retrieval Server

Memory

Brave Search

Context 7

🔎 GPT Researcher

MaxKB