Obsidian MCP Server Nyt

🚀 Obsidian MCP 服務器插件

此 Obsidian 插件可運行本地 MCP（模型上下文協議）服務器，讓外部應用程序（如 AI 助手、腳本或其他工具）藉助標準化接口與您的 Obsidian 知識庫進行交互，極大拓展了知識庫的使用場景。

這是一個尚在開發中的插件，當前功能雖已可用，但可能存在一些錯誤或未完成的功能。若您遇到任何問題，請隨時報告。由於開發者對 TypeScript 的掌握不夠熟練，插件可能存在安全性和可靠性問題。您可通過 GitHub 提交問題或拉取請求，開發者會盡快回復。

🚀 快速開始

在 Obsidian 中啟用插件後，訪問 http://localhost:<指定端口>/api 即可查看可用工具。

✨ 主要特性

• 本地 MCP 服務器：在配置的端口上運行基於流式傳輸協議（SSE）的 MCP 服務器。
• 知識庫索引以支持語義搜索：
  • 將 Markdown 筆記內容索引到 Orama 向量數據庫中。
  • 使用與 OpenAI 相兼容的嵌入模型（例如，OpenAI、通過兼容端點連接的本地 Ollama 模型）生成嵌入。
  • 支持配置文本分塊參數（大小、重疊、分隔符）。
  • 可通過類似 .gitignore 的語法排除特定文件或模式。
• Obsidian 集成：
  • 命令：在 Obsidian 命令調色板中提供以下命令：
    • 啟動/停止 MCP 服務器。
    • 重新索引整個知識庫（可能需要時間且根據嵌入提供商的不同可能會產生費用）。
    • 手動保存向量數據庫索引。
  • 設置面板：提供專用的設置選項卡，用於配置：
    • 服務器端口和自動啟動行為。
    • 嵌入模型詳細信息（API 端點、模型名稱、API 密鑰）。
    • 索引時排除文件或模式的文件排除規則。
    • 分塊參數。
    • 驗證嵌入提供商連接狀態。
  • 功能圖標：在 Obsidian 標題欄中添加狀態圖標，指示 MCP 服務器是正在運行還是已停止。
  • 多語言支持：根據 Obsidian 的語言設置，支持英文和中文界面。
• MCP 工具：此插件暴露的工具可通過配置的端口在外部應用程序中使用。默認情況下，這些工具通過 HTTP 端點訪問。

📦 安裝指南

該項目使用 TypeScript，安裝前請確保已安裝 Node.js 和 npm。

1. 克隆倉庫。
2. 運行 npm install 安裝依賴項。
3. 運行 npm run dev 編譯插件並監視文件變化。
4. 將生成的 main.js、manifest.json 和 styles.css 文件複製到您的 Obsidian 知識庫的 .obsidian/plugins/mcp-server/ 目錄中。
5. 重新加載 Obsidian 並啟用插件。

💻 使用示例

基礎用法

啟動 MCP 服務器：在 Obsidian 中啟用插件後，訪問 http://localhost:<指定端口>/api 查看可用工具。

高級用法

• 使用 MCP 工具：配置外部應用程序以與暴露的 HTTP 端點交互。
• 停止 MCP 服務器：使用“停止 MCP 服務器”命令關閉服務，避免資源浪費。

🔧 技術細節

配置

編輯 config.json 文件，指定 MCP 服務器使用的端口：

{
  "port": 3000,
  ...
}

已知問題及限制

• 文件大小限制：如果您的知識庫包含大量筆記，當 orama.json 文件超過 512MB 時，索引可能會失敗。目前沒有解決方法，只能通過減少筆記/分塊數量來緩解。
• 數字存儲：OramaDB 將浮點數存儲為原始字符串，這會導致數據庫大小迅速增加。

注意事項

⚠️ 重要提示

嵌入式模型的性能和行為可能因使用的具體模型而異。

💡 使用建議

OramaDB 的存儲機制可能導致數據庫文件快速增長，請定期監控文件大小並清理不必要的數據。