Obsidian Sync Mcp
by es617communityv0.5.2
17
5
The Obsidian Sync MCP server allows AI agents to access and manipulate notes in an Obsidian vault either locally or via CouchDB in the cloud. It supports various operations like reading, writing, and editing notes through HTTP requests.
From the registry: Give AI agents access to your Obsidian vault via local files or Self-hosted LiveSync.
Install & configure
Prerequisites
- requiredNode.js 22+Runtime requirement.
- requiredLaunch local MCP serverStart the server via npx with VAULT_PATH pointing at your Obsidian vault. The server listens on http://localhost:8787/mcp by default.
$ VAULT_PATH=~/Documents/MyVault VAULT_NAME=MyVault npx obsidian-sync-mcp
Install in your client
Paste into the AI you're chatting with — it will figure out the rest
Please install the `obsidian-sync-mcp` MCP server into my current AI client (that's you).
Required prerequisites (do these first if not already done):
- **Node.js 22+** — Runtime requirement.
- **Launch local MCP server** — Start the server via npx with VAULT_PATH pointing at your Obsidian vault. The server listens on http://localhost:8787/mcp by default. Run: `VAULT_PATH=~/Documents/MyVault VAULT_NAME=MyVault npx obsidian-sync-mcp`
Canonical MCP server config (HTTP transport):
- url: `http://localhost:8787/mcp`
Note: Server speaks Streamable HTTP (not stdio). Filesystem mode is simplest. CouchDB mode available for LiveSync users. Docker and Fly.io deployments also supported. Add `Authorization: Bearer <MCP_AUTH_TOKEN>` header if auth is enabled.
Add this MCP server to my current client's config in the correct format for you. If you need secrets or credentials I haven't provided, ASK me — do not invent values or leave raw placeholders. After adding it, tell me how to verify the server is connected.Note: Server speaks Streamable HTTP (not stdio). Filesystem mode is simplest. CouchDB mode available for LiveSync users. Docker and Fly.io deployments also supported. Add `Authorization: Bearer <MCP_AUTH_TOKEN>` header if auth is enabled.
Tools (9)
read_note
Read a note's markdown content by path
write_note
Create or overwrite a note (replaces entire content)
edit_note
Edit a note without rewriting it — append, prepend, or replace exact text
list_folders
List all folders in the vault with note counts
list_tags
List all tags in the vault with counts
list_notes
List notes with timestamps, filterable by folder, name, tag, or date
delete_note
Delete a note
move_note
Move or rename a note across folders
get_note_metadata
Get frontmatter, tags, outgoing links, backlinks, size, and timestamps
Environment variables
COUCHDB_PASSWORDrequiredCouchDB passwordMCP_AUTH_TOKENrequiredPassword for authenticationPrerequisites
- • Node 22+
Packages
obsidian-sync-mcp
npmv0.5.2transport: streamable-http
Details
- Language
- TypeScript
- License
- MIT
- Released
- Mar 30, 2026
- Last commit
- May 5, 2026
- Registry name
- io.github.es617/obsidian-sync-mcp