Obsidian

Servidor MCP para Obsidian

Servidor MCP para interagir com o Obsidian por meio do plugin comunitário Local REST API.

Componentes

Ferramentas

O servidor implementa várias ferramentas para interagir com o Obsidian:

• list_files_in_vault: Lista todos os arquivos e diretórios no diretório raiz do seu vault do Obsidian
• list_files_in_dir: Lista todos os arquivos e diretórios em um diretório específico do Obsidian
• get_file_contents: Retorna o conteúdo de um único arquivo no seu vault.
• search: Busca documentos que correspondem a uma consulta de texto especificada em todos os arquivos do vault
• patch_content: Insere conteúdo em uma nota existente em relação a um cabeçalho, referência de bloco ou campo frontmatter.
• append_content: Adiciona conteúdo a um arquivo novo ou existente no vault.

Exemplos de prompts

É bom primeiro instruir o Claude a usar o Obsidian. Depois disso, ele sempre chamará a ferramenta.

Use prompts como estes:

• Obtenha o conteúdo da última nota de chamada de arquitetura e resuma-o
• Busque todos os arquivos em que Azure CosmosDb é mencionado e explique-me rapidamente o contexto em que é mencionado
• Resuma as últimas notas de reunião e coloque-as em uma nova nota 'summary meeting.md'. Adicione uma introdução para que eu possa enviá-la por e-mail.

Configuração

Chave da API REST do Obsidian

Há duas maneiras de configurar o ambiente com a Chave da API REST do Obsidian.

1. Adicionar à configuração do servidor (preferida)

{
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY":"<your_api_key_here>"
    }
  }

2. Criar um arquivo .env no diretório de trabalho com a seguinte variável obrigatória:

OBSIDIAN_API_KEY=your_api_key_here

Observação: você pode encontrar a chave na configuração do plugin do Obsidian.

Início rápido

Instalação

Obsidian REST API

Você precisa do plugin comunitário Obsidian REST API em execução: https://github.com/coddingtonbear/obsidian-local-rest-api

Instale-o e habilite-o nas configurações e copie a chave da API.

Claude Desktop

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

No Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY" : "<YOUR_OBSIDIAN_API_KEY>"
      }
    }
  }
}

Desenvolvimento

Compilação

Para preparar o pacote para distribuição:

1. Sincronize as dependências e atualize o lockfile:

uv sync

Depuração

Como os servidores MCP rodam 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-obsidian run mcp-obsidian

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-obsidian.log