obsidian-sync-mcp
CommunityMCP server by es617 · updated · ★ 64 · 87 downloads a week
Give AI agents access to your Obsidian vault via local files or Self-hosted LiveSync. obsidian-sync-mcp is a community project by es617, not verified by a company domain.
Last commit 5 days ago
MIT: permissive, fine for commercial use
Clear description, published package or server URL, 64 stars, original repository
Downloads a script from the internet and runs it
What you need
| Setting | Needed | What it is |
|---|---|---|
VAULT_Environment variable | Optional | Path to your Obsidian vault directory (filesystem mode) |
COUCHDB_Environment variable | Optional | CouchDB server URL (CouchDB mode) |
COUCHDB_Environment variable | Optional | CouchDB username |
COUCHDB_Environment variable, secret | Optional | CouchDB password (required in CouchDB mode) |
COUCHDB_Environment variable | Optional | CouchDB database name |
COUCHDB_Environment variable, secret | Optional | LiveSync E2E encryption passphrase (must match plugin setting) |
COUCHDB_Environment variable | Optional | Set to 'true' if 'Obfuscate Properties' is enabled in LiveSync (obfuscates file paths, sizes, dates) |
VAULT_Environment variable | Optional | Vault name for deep links and index storage |
MCP_Environment variable, secret | Optional | Password for OAuth authentication |
BASE_Environment variable | Optional | Public URL for OAuth callbacks (required when using a tunnel) |
PORTEnvironment variable | Optional | HTTP port |
From the publisher's entry in the official MCP Registry. Required settings are already in the install config below as placeholders.
Install obsidian-sync-mcp
Built from the published package, never by AIclaude mcp add obsidian-sync-mcp -- npx -y obsidian-sync-mcpRun in your terminal. Add --scope user to use it in every project.
{
"mcpServers": {
"obsidian-sync-mcp": {
"command": "npx",
"args": [
"-y",
"obsidian-sync-mcp"
]
}
}
}Settings, Developer, Edit config. Paste into claude_desktop_config.json and restart.
{
"mcpServers": {
"obsidian-sync-mcp": {
"command": "npx",
"args": [
"-y",
"obsidian-sync-mcp"
]
}
}
}Add to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (this project).
{
"servers": {
"obsidian-sync-mcp": {
"command": "npx",
"args": [
"-y",
"obsidian-sync-mcp"
]
}
}
}Add to .vscode/mcp.json. VS Code uses "servers", not "mcpServers".
codex mcp add obsidian-sync-mcp -- npx -y obsidian-sync-mcp{
"mcpServers": {
"obsidian-sync-mcp": {
"command": "npx",
"args": [
"-y",
"obsidian-sync-mcp"
]
}
}
}Add to ~/.gemini/config/mcp_config.json (all projects) or .agents/mcp_config.json (this project).
gemini mcp add obsidian-sync-mcp npx -y obsidian-sync-mcpGemini CLI was replaced by Antigravity CLI in June 2026 and remains only for enterprise licences and paid API keys.
MCP servers run with your permissions and can read what you give them access to. Some need an API key: check the README and add it under env in the obsidian-sync-mcp block.
Weekly newsletter
Like obsidian-sync-mcp? Get the best new MCP servers every week
The best new tools, security warnings before you install something risky, and one practical tip. Free, three minute read.
Security check
C- Downloads a script from the internet and runs itIn
README.md:curl -L https://fly.io/install.sh | sh
Checked automatically: README.md, package.json. This looks for known risky patterns and is not a full audit. How grades work
Alternatives to obsidian-sync-mcp
All alternatives →Puter MCP enables AI tools to interact with Puter: manage files, websites, workers, and more
Open-source Obsidian for MDX - edit local docs with agent assistance
A private persistent computer: files and a bash shell that survive between runs.
MCP server for terminal commands, file operations, and process management
Filesystem-first framework for durable backend AI agents that run anywhere.
W3C Web Model Context Protocol (WebMCP) API polyfill. Let AI agents like Claude, ChatGPT, and Gemini interact with your website via document.modelContext.
obsidian-sync-mcp: common questions
How do I install obsidian-sync-mcp?
In Claude Code run claude mcp add obsidian-sync-mcp -- npx -y obsidian-sync-mcp. For Claude Desktop, Cursor and VS Code, paste the config shown above and restart. See the install guides.
Is obsidian-sync-mcp the official server?
obsidian-sync-mcp is a community project by es617, not verified by a company domain.
Is obsidian-sync-mcp free?
The code is published under the MIT licence. The service it connects to may have its own pricing.
Is obsidian-sync-mcp safe to use?
It scores 76 of 100. Grades: maintenance A, licence A, quality B. Security check: grade C (downloads a script from the internet and runs it). Review the code before you install. How grades work.
What are alternatives to obsidian-sync-mcp?
Similar MCP servers: mcp-server, Agent-Native Content, Computer, Desktop Commander.
Does obsidian-sync-mcp work with ChatGPT?
Not directly. It runs locally, and ChatGPT only connects to remote servers with a URL. Use it in Claude Code, Claude Desktop, Cursor, VS Code or Codex.
