obsidian-sync-mcp

What this does

obsidian-sync-mcp exposes a set of tools to Claude over the Model Context Protocol. After you add it to claude_desktop_config.json (snippet above) and restart Claude Desktop, those tools become callable inside any conversation.

Requirements

This server needs the following environment variables to be set before it can run:

VAULT_PATH
COUCHDB_URL
COUCHDB_USER
COUCHDB_PASSWORD
COUCHDB_DATABASE
COUCHDB_PASSPHRASE
COUCHDB_OBFUSCATE_PROPERTIES
VAULT_NAME
MCP_AUTH_TOKEN
BASE_URL
PORT

Set these via the env object in your MCP config (see claude_desktop_config.json snippet above).

How do I install obsidian-sync-mcp?

Run the Claude Code command in the install section to add obsidian-sync-mcp to Claude Code, or copy the ready-made config for your client from the install section on this page. Restart your client afterwards and the tools appear in your next conversation.

Which clients work with obsidian-sync-mcp?

This page carries setup and config for Claude Code, Claude Desktop, Cursor and VS Code. Any other MCP client that accepts a standard server config can connect to obsidian-sync-mcp as well.

Does obsidian-sync-mcp need an API key?

Yes. Before it can run, set these environment variables: VAULT_PATH, COUCHDB_URL, COUCHDB_USER, COUCHDB_PASSWORD, COUCHDB_DATABASE, COUCHDB_PASSPHRASE, COUCHDB_OBFUSCATE_PROPERTIES, VAULT_NAME, MCP_AUTH_TOKEN, BASE_URL, PORT. They go in the env block of your MCP config.