Skip to content

edimuj/scribe-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

scribe-mcp

MCP server that gives AI agents CRUD access to Obsidian notes via LiveSync's CouchDB backend.

Built with Deno and the official livesync-commonlib library. Handles encryption, compression, and path obfuscation transparently.

Tools

Tool Description
vault_status Vault overview — document count, folders, encryption/compression status
vault_list List notes, optionally filtered by folder or glob pattern
vault_read Read a note's content and metadata
vault_search Full-text search across all notes (case-insensitive)
vault_write Create or update a note
vault_delete Delete a note

Prerequisites

Setup

  1. Clone with submodules:

    git clone --recurse-submodules https://github.com/edimuj/scribe-mcp.git
    cd scribe-mcp
  2. Copy and edit the environment file:

    cp .env.example .env
    Variable Required Description
    SCRIBE_COUCHDB_URL Yes CouchDB URL (e.g. http://localhost:5984)
    SCRIBE_COUCHDB_USER Yes CouchDB username
    SCRIBE_COUCHDB_PASS Yes CouchDB password
    SCRIBE_COUCHDB_DB Yes Database name (e.g. obsidian-livesync)
    SCRIBE_PASSPHRASE If E2EE Vault passphrase (only needed if vault uses end-to-end encryption)
  3. Run:

    deno task start

Claude Code / MCP client configuration

Add to your MCP client config (e.g. .claude.json):

{
  "mcpServers": {
    "scribe": {
      "command": "deno",
      "args": ["run", "-A", "--no-check", "/path/to/scribe-mcp/src/main.ts"],
      "env": {
        "SCRIBE_COUCHDB_URL": "http://localhost:5984",
        "SCRIBE_COUCHDB_USER": "admin",
        "SCRIBE_COUCHDB_PASS": "changeme",
        "SCRIBE_COUCHDB_DB": "obsidian-livesync",
        "SCRIBE_PASSPHRASE": "your-passphrase"
      }
    }
  }
}

License

MIT

About

MCP server for Obsidian LiveSync vaults

Topics

Resources

Stars

Watchers

Forks

Contributors