MCP Obsidian Index

🚀 Obsidian索引MCP服務器

這是一個具備語義搜索功能的MCP服務器，它依託Obsidian保險庫，能將近期的筆記資源對外公開，為用戶提供便捷的筆記搜索與訪問服務。

✨ 主要特性

資源提供

服務器會把保險庫中最近修改的筆記當作資源提供給MCP客戶端。這些筆記具有以下特點：

• 通過obsidian://<VAULT_NAME>/<NOTE_PATH>自定義URL方案進行唯一標識。
• 筆記的媒體類型為text/markdown。

實用工具

服務器實現了一個實用工具：

• search-notes：可在已索引的筆記上執行語義搜索。

📦 安裝指南

運行服務器

使用以下命令來運行服務器：

uv run obsidian-index mcp --vault <VAULT_PATH> --database <DATABASE_PATH> --reindex --watch

參數說明：

• --vault：保險庫路徑（可多次指定）。
• --database：本地數據庫文件路徑（若不存在則會自動創建）。
• --reindex：對所有保險庫中的筆記重新進行索引（目前可能每次運行此命令時都需使用）。
• --watch：監視保險庫中的更改，並相應地更新索引。

Claude Desktop配置

• MacOS：配置文件路徑為~/Library/Application\ Support/Claude/claude_desktop_config.json。
• Windows：配置文件路徑為%APPDATA%/Claude/claude_desktop_config.json%。

💻 使用示例

基礎用法

運行服務器的基礎命令如下：

uv run obsidian-index mcp --vault <VAULT_PATH> --database <DATABASE_PATH> --reindex --watch

📚 詳細文檔

構建和發佈

若要準備分發包，可按以下步驟操作：

1. 同步依賴並更新鎖定文件：

uv sync

2. 構建發行版：

uv build

此操作會在dist/目錄下創建源代碼和wheel發行版。 3. 發佈到PyPI：

uv publish

注意：您需要通過環境變量或命令行參數設置PyPI憑證：

• 令牌：--token或UV_PUBLISH_TOKEN。
• 或者用戶名/密碼：--username/UV_PUBLISH_USERNAME和--password/UV_PUBLISH_PASSWORD。

調試

由於MCP服務器通過標準輸入輸出運行，調試可能存在一定挑戰。為獲得最佳調試體驗，強烈推薦使用MCP Inspector。

您可以使用以下命令啟動MCP Inspector：

npx @modelcontextprotocol/inspector uv --directory <PATH_TO_PROJECT> run obsidian-index

啟動後，Inspector會顯示一個URL，您可在瀏覽器中訪問該URL以開始調試。