Obsidian için MCP sunucusu

Obsidian ile Local REST API community eklentisi aracılığıyla etkileşim kurmak için MCP sunucusu.

Bileşenler

Araçlar

Sunucu, Obsidian ile etkileşim kurmak için birden fazla aracı uygular:

• list_files_in_vault: Obsidian kasanızın kök dizinindeki tüm dosya ve dizinleri listeler
• list_files_in_dir: Belirli bir Obsidian dizinindeki tüm dosya ve dizinleri listeler
• get_file_contents: Kasanızdaki tek bir dosyanın içeriğini döndürür
• search: Kasadaki tüm dosyalarda belirtilen metni arayarak eşleşen belgeleri arar
• patch_content: Mevcut bir nota bir başlık, blok referansı veya frontmatter alanına göre içerik ekler
• append_content: Kasada yeni veya mevcut bir dosyaya içerik ekler
• delete_file: Kasanızdan bir dosya veya dizin siler

Örnek komutlar

İlk olarak Claude'a Obsidian'ı kullanmasını talimat vermek iyi bir fikirdir. Daha sonra her zaman aracı çağıracaktır.

Şu gibi komutlar kullanın:

• Son mimari çağrı notunun içeriğini alın ve özetleyin
• Azure CosmosDb'nin bahsedildiği tüm dosyaları arayın ve bana kısaca bunun bahsedildiği bağlamı açıklayın
• Son toplantı notlarını özetleyin ve bunları yeni bir nota 'toplantı özeti.md' olarak koyun. E-posta gönderebilmem için bir giriş ekleyin.

Konfigürasyon

Obsidian REST API Anahtarı

Obsidian REST API Anahtarı ile ortamı konfigüre etmenin iki yolu vardır.

1. Sunucu konfigürasyonuna ekleyin (tercih edilen)

{
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY": "<your_api_key_here>",
      "OBSIDIAN_HOST": "<your_obsidian_host>",
      "OBSIDIAN_PORT": "<your_obsidian_port>"
    }
  }
}

Bazen Claude, uv / uvx konumunu tespit etmekte sorun yaşayabilir. Bu durumda which uvx komutunu kullanarak tam yolu bulabilir ve yukarıdaki konfigürasyona yapıştırabilirsiniz.

2. Çalışma dizininde aşağıdaki gerekli değişkenlerle .env dosyası oluşturun:

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host
OBSIDIAN_PORT=your_obsidian_port

Not:

• API anahtarını Obsidian eklenti konfigürasyonunda bulabilirsiniz
• Belirtilmemişse varsayılan port 27124'tür
• Belirtilmemişse varsayılan host 127.0.0.1'dir

Hızlı Başlangıç

Kurulum

Obsidian REST API

Obsidian REST API community eklentisinin çalışıyor olması gerekir: https://github.com/coddingtonbear/obsidian-local-rest-api

Ayarlardan yükleyin ve etkinleştirin ve api anahtarını kopyalayın.

Claude Desktop

MacOS'ta: ~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows'ta: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "<your_api_key_here>",
        "OBSIDIAN_HOST": "<your_obsidian_host>",
        "OBSIDIAN_PORT": "<your_obsidian_port>"
      }
    }
  }
}

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "<YOUR_OBSIDIAN_API_KEY>",
        "OBSIDIAN_HOST": "<your_obsidian_host>",
        "OBSIDIAN_PORT": "<your_obsidian_port>"
      }
    }
  }
}

Geliştirme

Derleme

Paketi dağıtım için hazırlamak için:

1. Bağımlılıkları senkronize edin ve lock dosyasını güncelleyin:

uv sync

Hata Ayıklama

MCP sunucuları stdio üzerinden çalıştığından, hata ayıklama zor olabilir. En iyi hata ayıklama deneyimi için MCP Inspector kullanmanızı şiddetle tavsiye ederiz.

MCP Inspector'ı bu komut ile npm üzerinden başlatabilirsiniz:

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian

Başlatıldığında, Inspector hata ayıklamaya başlamak için tarayıcınızda erişebileceğiniz bir URL görüntüleyecektir.

Ayrıca sunucu günlüklerini şu komut ile izleyebilirsiniz:

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log