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
Installing via Smithery
To install MCP Server Obsidian Omnisearch for Claude Desktop automatically via Smithery:
Manual Installation
- Clone the repository:
- Install dependencies:
Configuration
The Obsidian vault path is now provided as a command line argument when running the server:
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
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:
- Sync dependencies and update lockfile:
- Build package distributions:
This will create source and wheel distributions in the dist/
directory.
- Publish to PyPI:
Note: You'll need to set PyPI credentials via environment variables or command flags:
- Token:
--token
orUV_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:
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:
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.
local-only server
The server can only run on the client's local machine because it depends on local resources.
通过 REST API 接口为 Obsidian 保险库提供编程搜索功能,允许外部应用程序搜索注释并检索匹配文档的绝对路径。
Related Resources
Related MCP Servers
- -securityFlicense-qualityProvides semantic search capability over Obsidian vaults and exposes recent notes as resources to Claude through the MCP protocol.Last updated -7
- -securityAlicense-qualityProvides a standardized interface for AI assistants to interact with Obsidian vaults through a local REST API, enabling reading, writing, searching, and managing notes.Last updated -53MIT License
- AsecurityAlicenseAqualityA server that enables AI agents to perform sophisticated knowledge discovery and analysis across Obsidian vaults through the Local REST API plugin, supporting complex multi-step workflows with advanced filtering and full content retrieval.Last updated -317MIT License
- AsecurityAlicenseAqualityEmpowers AI agents to deeply understand and interact with Obsidian vaults through the Local REST API, enabling advanced features like vault structure discovery, graph analysis, command execution, and batch file operations.Last updated -164MIT License