Obsidian MCP Tools

🚀 MCP 工具插件

MCP 工具插件是專門為 Obsidian 打造的一套插件集合，它能與遵循模型上下文協議（MCP）的 AI 服務進行交互，支持數據輸入、處理和輸出等功能，還兼容多種 MCP 客戶端，為用戶提供了便捷的使用體驗。

🚀 快速開始

MCP 工具插件（Model Context Protocol Tools，簡稱 MCP Tools）是專為 Obsidian 設計的插件集合，用於與遵循模型上下文協議（MCP）的 AI 服務交互。以下是快速上手步驟：

1. 確保滿足安裝的前置條件，即安裝 Obsidian 最新版本並具備互聯網連接。
2. 完成插件的下載與安裝。
3. 安裝完成後重啟 Obsidian。
4. 打開側邊欄，選擇 MCP 工具插件圖標。
5. 在彈出的界面中配置 API 鍵或訪問令牌。
6. 開始使用 MCP 服務。

✨ 主要特性

• 與遵循 MCP 協議的 AI 服務交互。
• 提供數據輸入、處理和輸出功能。
• 支持多種格式的數據交換。

📦 安裝指南

前置條件

• Obsidian 最新版本。
• 具備互聯網連接。

下載與安裝

1. 訪問 MCP Tools 倉庫。
2. 在 Releases 頁面下載適用於你係統的插件包。
3. 將下載的 .zip 文件解壓並複製到 appdata 目錄下的 Plugins 文件夾中：

   Windows: C:\Users\<你的用戶名>\AppData\Roaming\Obsidian\Plugins
   macOS: /Users/<你的用戶名>/Library/Application Support/Obsidian/Plugins
   Linux: ~/.config/obsidian/Plugins
   

💻 使用示例

基礎用法

以下是使用 MCP 工具插件的基礎步驟：

1. 安裝完成後重啟 Obsidian。
2. 打開側邊欄，選擇 MCP 工具插件圖標。
3. 在彈出的界面中配置 API 鍵或訪問令牌。
4. 開始使用 MCP 服務。

🔧 技術細節

安全方面

二進制分發

• 所有發佈版本均通過 GitHub Actions 進行可重複構建。
• 二進制文件帶有 SLSA 出證，確保完整性和來源。
• 發佈工作流完全符合開源標準。

運行時安全

• 服務器以最小權限運行。
• 所有通信均為加密。
• API 密鑰使用平臺特定的憑據存儲進行保護。

開發方面

工程結構

MCP 工具插件採用單體倉庫架構，包含以下模塊：

packages/
├── mcp-server/        # 服務器實現
├── obsidian-plugin/   # Obsidian 插件
└── shared/           # 公共工具和類型

使用 Cline

部分代碼由 AI 編碼代理 Cline 實現，參考 cline_docs/ 和 .clinerules 文件瞭解項目架構。

工作區

該項目使用 Bun 工作區結構：

• 依賴管理：
  1. 安裝依賴：

  bun install
  

  2. 構建所有包：

  bun run build
  

  3. 開發模式運行：

  bun run dev
  

• 配置要求：
  • Bun v1.1.42 或更高版本。
  • TypeScript 5.0+。

🤝 貢獻指南

1. Fork 倉庫。
2. 創建功能分支。
3. 提交更改。
4. 運行測試：

   bun test
   

5. 提交 Pull Request。

詳細指南請參閱 CONTRIBUTING.md。

🛠️ 支持

• 在 Issues 中報告問題和功能需求。
• 在 Discussions 中尋求幫助。

📜 變更日誌

詳細變更記錄請參考 CHANGELOG.md。

📄 許可證

項目遵循 MIT 許可證，具體條款見 LICENSE 文件。

📌 腳註

1. MCP 協議定義了 AI 服務與客戶端之間的交互標準。
2. 插件支持的 API 格式包括 JSON、XML 和自定義格式。
3. 所有腳本均經過嚴格測試，確保兼容性和穩定性。