Obsidian Omnisearch

MCP Server Obsidian Omnisearch

Um servidor baseado em FastMCP que fornece funcionalidade de busca no cofre do Obsidian por meio de uma interface de API REST.

Visão Geral

Este projeto implementa um serviço de busca que permite pesquisar programaticamente nas notas do cofre do Obsidian. Ele usa FastMCP para expor a funcionalidade de busca como uma ferramenta que pode ser integrada a outros serviços.

Recursos

• Busca em notas do cofre do Obsidian
• Integração com API REST
• Retorna caminhos absolutos para as notas correspondentes
• Fácil integração com ferramentas FastMCP

Pré-requisitos

• Python 3.x
• Obsidian com o plugin Omnisearch instalado e em execução
• Biblioteca FastMCP
• Cofre do Obsidian ativo

Instalação

Instalando via Smithery

Para instalar o MCP Server Obsidian Omnisearch para Claude Desktop automaticamente via Smithery:

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

Instalação Manual

1. Clone o repositório:

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

2. Instale as dependências:

uv install

Configuração

O caminho do cofre do Obsidian agora é fornecido como um argumento de linha de comando ao executar o servidor:

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

Uso

API Obsidian Omnisearch

Você precisa do plugin da comunidade Obsidian Omnisearch em execução: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine

Claude Desktop

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

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

Referência da API

Buscar Notas

• Função: obsidian_notes_search(query: str)
• Descrição: Busca notas no Obsidian e retorna caminhos absolutos para as notas correspondentes
• Parâmetros:
  • query: String de consulta de busca
• Retorna: Lista de caminhos absolutos para as notas correspondentes

Desenvolvimento

Construção e Publicação

Para preparar o pacote para distribuição:

1. Sincronize as dependências e atualize o arquivo de bloqueio:

uv sync

2. Construa as distribuições do pacote:

uv build

Isso criará distribuições de origem e wheel no diretório dist/.

3. Publique no PyPI:

uv publish

Nota: Você precisará definir as credenciais do PyPI por meio de variáveis de ambiente ou flags de comando:

• Token: --token ou UV_PUBLISH_TOKEN
• Ou nome de usuário/senha: --username/UV_PUBLISH_USERNAME e --password/UV_PUBLISH_PASSWORD

Depuração

Como os servidores MCP são executados via stdio, a depuração pode ser desafiadora. Para a melhor experiência de depuração, recomendamos fortemente o uso do MCP Inspector.

Você pode iniciar o MCP Inspector via npm com este comando:

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

Ao iniciar, o Inspector exibirá uma URL que você pode acessar no seu navegador para começar a depurar.

Você também pode observar os logs do servidor com este comando:

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

Dependências

• FastMCP
• requests
• urllib

Licença

Este projeto é licenciado sob a Licença MIT - consulte o arquivo LICENSE para obter detalhes.

Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para enviar um Pull Request.