obsidian-mcp
Integrates with Obsidian by connecting to the Local REST API plugin, enabling AI agents and CLI users to read, create, update, delete, search, and open notes, list files and tags, retrieve the active file, and execute Obsidian commands.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@obsidian-mcp read my note 'Project Ideas.md'"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Obsidian MCP Server & CLI (WSL to Windows)
Servidor MCP (Model Context Protocol) e ferramenta de linha de comando (CLI) para integrar o Obsidian rodando no Windows com agentes de IA (Antigravity, Claude Desktop, Cursor, Cline) e terminais rodando no WSL2 ou Linux.
🚀 Funcionalidades
Detecção automática de IP do Windows: Resolve dinamicamente o IP do host Windows a partir do WSL2 (
ip route default//etc/resolv.conf).Suporte a HTTPS autoassinado: Aceita os certificados SSL padrão gerados pelo plugin Local REST API do Obsidian.
Protocolo MCP nativo (stdio): Compatível com Google Antigravity, Claude Desktop, Cursor e qualquer cliente MCP.
CLI integrada: Permite interagir com o Obsidian diretamente pelo terminal bash no WSL.
Ferramentas MCP Disponíveis
Ferramenta | Descrição |
| Retorna o caminho e conteúdo da nota aberta/em foco no Obsidian |
| Abre uma nota no Obsidian no Windows, tornando-a a aba ativa |
| Lê o conteúdo markdown completo de uma nota do vault |
| Cria ou atualiza o conteúdo de uma nota |
| Adiciona texto ao final de uma nota existente |
| Remove uma nota do vault |
| Lista arquivos e pastas do vault |
| Pesquisa no índice interno de notas do Obsidian |
| Lista todas as tags e suas contagens de ocorrência |
| Lista os comandos disponíveis na paleta do Obsidian |
| Executa um comando da paleta do Obsidian |
Related MCP server: Obsidian MCP Server
📋 Pré-requisitos
Obsidian instalado no Windows com o plugin comunitário Local REST API instalado e ativado.
Copie a chave de API gerada nas configurações do plugin Local REST API no Obsidian.
Node.js (v18+) e npm instalados no ambiente WSL2 / Linux.
⚙️ Instalação e Configuração
Clone o repositório:
git clone https://github.com/artgustavobarros/obsidian-mcp.git
cd obsidian-mcpInstale as dependências:
npm installConfigure o arquivo de ambiente:
cp .env.example .envEdite o arquivo .env:
OBSIDIAN_API_KEY=sua_chave_de_api_aqui
OBSIDIAN_PORT=27124
OBSIDIAN_PROTOCOL=https
# Deixe OBSIDIAN_HOST vazio para detecção automática do IP do Windows no WSL2:
OBSIDIAN_HOST=Compile o projeto TypeScript:
npm run build🛠️ Configuração nos Clientes MCP
Antigravity (~/.gemini/antigravity-cli/mcp_config.json)
{
"mcpServers": {
"obsidian": {
"command": "node",
"args": ["/caminho/absoluto/para/obsidian-mcp/dist/index.js"],
"env": {
"OBSIDIAN_API_KEY": "sua_chave_aqui"
}
}
}
}Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"obsidian": {
"command": "node",
"args": ["/caminho/absoluto/para/obsidian-mcp/dist/index.js"]
}
}
}💻 Uso via Linha de Comando (CLI)
Você pode interagir diretamente com o Obsidian a partir do terminal:
# Verificar status da conexão
node dist/cli.js status
# Ver qual nota está aberta no momento
node dist/cli.js active
# Ler uma nota
node dist/cli.js read "Minhas Anotações.md"
# Abrir uma nota no Obsidian no Windows
node dist/cli.js open "01 - Sessões/Sessão 01.md"
# Buscar notas
node dist/cli.js search "projeto"
# Adicionar conteúdo a uma nota
node dist/cli.js append "Diário/2026-10-16.md" "Reunião finalizada com sucesso."
# Listar tags
node dist/cli.js tags
# Executar comando da paleta
node dist/cli.js cmd "app:open-vault"Opcionalmente, vincule o CLI globalmente no WSL:
npm link
# Agora você pode usar diretamente:
obsidian status
obsidian active📄 Licença
Distribuído sob a licença MIT.
Available Tools
11 toolsappend_to_noteC
Adiciona texto ao final de uma nota existente no vault do Obsidian.
Inputs: path (required), content (required).
create_or_update_noteB
Cria uma nova nota ou sobrescreve o conteúdo de uma nota existente no vault do Obsidian.
Inputs: path (required), content (required).
delete_noteC
Exclui uma nota do vault do Obsidian.
Inputs: path (required).
execute_commandC
Executa uma ação da paleta de comandos do Obsidian no Windows.
Inputs: commandId (required).
get_active_fileA
Retorna o caminho e conteúdo completo da nota atualmente aberta ou em foco na janela do Obsidian no Windows.
Inputs: no named parameters.
list_commandsB
Lista todos os comandos da paleta do Obsidian disponíveis no Windows.
Inputs: no named parameters.
list_filesB
Lista arquivos e subpastas de um diretório do vault do Obsidian.
Inputs: directory.
list_tagsA
Lista todas as tags utilizadas no vault e a quantidade de ocorrências de cada uma.
Inputs: no named parameters.
open_fileA
Abre uma nota na interface do Obsidian no Windows, tornando-a a aba ativa.
Inputs: path (required).
read_noteB
Lê o conteúdo markdown completo de uma nota do vault do Obsidian.
Inputs: path (required).
search_notesC
Pesquisa notas no vault utilizando o índice interno de busca do Obsidian.
Inputs: query (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 11 tools
Most tools target a distinct resource+action (read_note, delete_note, list_tags, execute_command). The main overlap is between get_active_file and read_note, which both return note content, though the 'active/focused' scope distinguishes them; create_or_update_note also bundles two actions but is unambiguous.
All 11 tools follow a consistent snake_case verb_noun pattern (get_active_file, open_file, read_note, append_to_note, list_files, search_notes). No mixing of camelCase or alternate verb styles.
11 tools is well within the ideal 3-15 range for a vault/note management server. Each tool earns its place covering file navigation, CRUD, search, tags, and command execution without redundancy.
Core lifecycle is covered: read, create/update, append, delete, plus listing, search, tags, and command execution. Minor gaps exist (no rename/move note, no folder creation, no metadata/frontmatter access), but agents can work around these using create_or_update_note and execute_command.
Maintenance
Related MCP Connectors
Connect AI assistants to your GitHub-hosted Obsidian vault to seamlessly access, search, and analy…
Connect ChatGPT, Claude, Cursor or VS Code to your Windows PC: files, terminal, browser, apps.
Search your Obsidian vault to quickly find notes by title or keyword, summarize related content, a…
Search and reason over your Obsidian-style Markdown vault, right from ChatGPT.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceProvides a standardized interface for AI assistants to interact with Obsidian vaults through a local REST API, enabling reading, writing, searching, and managing notes.69MIT
- AlicenseAqualityDmaintenanceConnects to Obsidian vaults via the Local REST API plugin, enabling AI-assisted Zettelkasten workflows including creating atomic notes, searching content, managing links and tags, and performing precise content editing operations.13MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to manage Obsidian notes via local REST API, supporting file CRUD, search, commands, and periodic notes.3,971 npm7Apache 2.0
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to search, read, and analyze Obsidian notes via the Local REST API.24 npm17ISC