Obsidian MCP Local Server

🚀 Obsidian MCP (模型上下文協議) 服務器

該項目實現了一個 Model Context Protocol (MCP) 服務器，用於連接 AI 模型與 Obsidian 知識庫。藉助此服務器，AI 模型能夠讀取、創建、更新和刪除筆記，還能管理文件夾並進行全文搜索。

🚀 快速開始

本項目可連接 AI 模型與 Obsidian 知識庫，讓 AI 模型對筆記和文件夾進行多種操作，如讀取、創建、更新、刪除筆記，管理文件夾及全文搜索。

✨ 主要特性

• 支持 AI 模型對 Obsidian 知識庫中的筆記進行讀取、創建、更新和刪除操作。
• 能夠管理文件夾，包括創建、重命名、移動和刪除操作。
• 提供全文搜索功能，方便在知識庫中查找內容。

📦 安裝指南

先決條件

• Node.js v16 或更高版本
• 安裝了 Obsidian 桌面應用程序
• 已安裝並配置好 Obsidian Local REST API 插件

安裝步驟

1. 克隆倉庫
   使用以下命令將項目倉庫克隆到本地：

   git clone https://github.com/yourusername/obsidian-mcp-server.git
   

2. 安裝依賴項
   進入項目目錄後，運行以下命令以安裝所需的依賴項：

   npm install
   

3. 構建項目
   安裝完成後，運行以下命令進行構建：

   npm run build
   

🔧 配置

項目的配置通過環境變量完成。以下是需要設置的關鍵環境變量：

• VAULT_PATH：Obsidian 知識庫的存儲路徑。
• API_KEY：Obsidian Local REST API 的訪問令牌。
• PORT：服務器運行的端口號，默認為 3000。

示例 .env 文件如下：

VAULT_PATH=/path/to/obsidian-vault
API_KEY=your_api_key_here
PORT=3000

⚠️ 重要提示

請勿將包含敏感信息的 .env 文件提交到版本控制系統中。

💻 使用示例

直接運行

在項目根目錄下，運行以下命令啟動服務器：

npm start

使用 Docker 部署

如果您已經構建了 Docker 鏡像，可以使用以下命令啟動容器：

docker run -it --env-file .env yourusername/obsidian-mcp-server

📚 詳細文檔

支持的工具

MCP 服務器提供以下功能模塊：

• list_notes：列出知識庫中的所有筆記。
• read_note：讀取指定筆記的內容。
• create_note：創建新筆記。
• update_note：更新現有筆記內容。
• search_vault：在知識庫中搜索內容。
• delete_note：刪除指定筆記。
• manage_folder：管理文件夾（包括創建、重命名、移動和刪除操作）。

開發

開發模式

使用以下命令以開發模式運行服務器：

npm run dev

源代碼結構

源代碼位於 src 目錄中。主要文件包括：

• server.js：主服務器入口文件。
• notes.js 和 folders.js：處理筆記和文件夾操作的業務邏輯文件。

測試

項目提供了一個測試腳本，用於驗證服務器功能：

node test-mcp.js

📄 許可證

ISC

🤝 貢獻

歡迎提交 Pull Requests 和 Issues！我們非常感謝您的貢獻。

🔗 相關項目

• Model Context Protocol：模型上下文協議的官方實現。
• Obsidian Local REST API：用於與 Obsidian 知識庫進行交互的本地REST API插件。