Obsidian Omnisearch MCP Server

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Provides searchable access to Obsidian vault notes through the Omnisearch plugin, returning absolute file paths to matching notes based on search queries

Servidor MCP Obsidian Omnisearch

Un servidor basado en FastMCP que proporciona la funcionalidad de búsqueda de bóveda de Obsidian a través de una interfaz API REST.

Descripción general

Este proyecto implementa un servicio de búsqueda que permite buscar en las notas de la bóveda de Obsidian mediante programación. Utiliza FastMCP para exponer la funcionalidad de búsqueda como una herramienta integrable con otros servicios.

Características

  • Buscar en las notas de la bóveda de obsidiana
  • Integración de API REST
  • Devuelve rutas absolutas a las notas coincidentes
  • Fácil integración con las herramientas FastMCP

Prerrequisitos

  • Python 3.x
  • Obsidian con el complemento Omnisearch instalado y en ejecución
  • Biblioteca FastMCP
  • Bóveda de obsidiana activa

Instalación

Instalación mediante herrería

Para instalar MCP Server Obsidian Omnisearch para Claude Desktop automáticamente a través de Smithery :

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

Instalación manual

  1. Clonar el repositorio:
git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git cd mcp-server-obsidian-omnisearch
  1. Instalar dependencias:
uv install

Configuración

La ruta de la bóveda de Obsidian ahora se proporciona como un argumento de línea de comando al ejecutar el servidor:

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

Uso

API de búsqueda omnidireccional de Obsidian

Necesita el complemento de la comunidad Obsidian Omnisearch en ejecución: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine

Escritorio de Claude

En MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

En 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" ] } } }

Referencia de API

Notas de búsqueda

  • Función: obsidian_notes_search(query: str)
  • Descripción: Busca notas de Obsidian y devuelve rutas absolutas a las notas coincidentes
  • Parámetros:
    • query : cadena de consulta de búsqueda
  • Devuelve: Lista de rutas absolutas a notas coincidentes

Desarrollo

Construcción y publicación

Para preparar el paquete para su distribución:

  1. Sincronizar dependencias y actualizar el archivo de bloqueo:
uv sync
  1. Distribuciones de paquetes de compilación:
uv build

Esto creará distribuciones de origen y de rueda en el directorio dist/ .

  1. Publicar en PyPI:
uv publish

Nota: Deberás configurar las credenciales de PyPI a través de variables de entorno o indicadores de comando:

  • Token: --token o UV_PUBLISH_TOKEN
  • O nombre de usuario/contraseña: --username / UV_PUBLISH_USERNAME y --password / UV_PUBLISH_PASSWORD

Depuración

Dado que los servidores MCP se ejecutan en stdio, la depuración puede ser complicada. Para una experiencia óptima, recomendamos usar el Inspector MCP .

Puede iniciar el Inspector MCP a través de npm con este comando:

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-server-obsidian-omnisearch run mcp-server-obsidian-omnisearch

Al iniciarse, el Inspector mostrará una URL a la que podrá acceder en su navegador para comenzar a depurar.

También puedes ver los registros del servidor con este comando:

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

Dependencias

  • FastMCP
  • solicitudes
  • urllib

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

-
security - not tested
A
license - permissive license
-
quality - not tested

Proporciona una funcionalidad de búsqueda programática para bóvedas de Obsidian a través de una interfaz de API REST, lo que permite que las aplicaciones externas busquen notas y recuperen rutas absolutas a los documentos coincidentes.

  1. Overview
    1. Features
      1. Prerequisites
        1. Installation
          1. Installing via Smithery
          2. Manual Installation
        2. Configuration
          1. Usage
            1. Obsidian Omnisearch API
            2. Claude Desktop
          2. API Reference
            1. Search Notes
          3. Development
            1. Building and Publishing
            2. Debugging
          4. Dependencies
            1. License
              1. Contributing
                ID: cg8qcv2k9c