Obsidian MCP Rest

🚀 Obsidian MCP REST 服務器

這是一個實現 Model Context Protocol (MCP) 的服務器，藉助本地 REST API 實現對 Obsidian 筆記 vaults 的訪問。該服務器為 AI 助手提供了標準化接口，使其能夠與 Obsidian 筆記進行交互，並對 vault 內容進行管理。

🚀 快速開始

此服務器允許你通過本地 REST API 訪問 Obsidian 筆記 vaults，為 AI 助手與筆記的交互提供便利。

✨ 主要特性

• 通過 MCP 訪問 Obsidian vault 內容
• 支持筆記的讀取和寫入操作
• 可列出 vault 內的內容
• 具備搜索功能
• 集成了安全的本地 REST API
• 與 Claude Desktop 及其他 AI 助手兼容

📦 安裝指南

全局安裝包

npm install -g PublikPrinciple/obsidian-mcp-rest

使用特定版本/分支

npm install -g PublikPrinciple/obsidian-mcp-rest#main

📚 詳細文檔

配置

配置 Obsidian Local REST API 插件

1. 在 Obsidian 中安裝 Local REST API 插件。
2. 設置 API 端口（默認：27123）。
3. 生成並保存 API 密鑰。

創建配置文件 config.json

{
  "obsidian": {
    "apiKey": "your-api-key-here",
    "port": 27123,
    "host": "localhost"
  },
  "server": {
    "name": "obsidian-mcp",
    "version": "1.0.0"
  }
}

使用方法

啟動服務器

obsidian-mcp-rest --config path/to/config.json

服務器啟動後，將監聽通過 stdin/stdout 的 MCP 請求。

與 Claude Desktop 集成

1. 配置 Claude Desktop 使用此 MCP 服務器：
   • 打開 Claude Desktop 設置。
   • 進入 MCP 部分。
   • 添加新的服務器配置：

{
  "name": "obsidian-mcp",
  "command": "obsidian-mcp-rest",
  "args": ["--config", "path/to/config.json"]
}

2. Claude 可通過以下命令訪問 Obsidian vault：

讀取筆記 "Projects/MyProject.md"
列出 "Projects" 文件夾中的所有筆記
搜索包含 "typescript" 的筆記

可用工具

• listNotes：列出 vault 中的所有筆記或特定文件夾的筆記
• readNote：讀取特定筆記的內容
• writeNote：創建或更新筆記
• searchNotes：搜索符合指定條件的筆記
• getMetadata：獲取筆記的元數據

安全注意事項

• 所有 API 請求都通過生成的 API 密鑰進行身份驗證。
• 服務器僅限本地網絡訪問，防止外部訪問。
• 數據保留在本地設備，不會上傳到任何服務器。

開發

克隆倉庫

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git

進入項目目錄並安裝依賴項

cd obsidian-mcp-rest
npm install

構建項目

npm run build

運行測試

npm test

故障排除

若安裝失敗，可嘗試手動克隆倉庫，並在其中運行安裝和構建命令。同時，要確保 Node.js 和其他依賴項已正確安裝。

貢獻

歡迎提交 Pull Request！對於重大變更，請先在問題中討論以獲得反饋。

📄 許可證

此項目使用 MIT 許可證，詳細信息請參閱 LICENSE 文件。