Obsidian MCP

🚀 Obsidian - MCP MCP 服務器

本項目是一個基於 TypeScript 的 MCP 服務器，實現了與 Obsidian 的集成。它能幫助用戶更好地利用 Obsidian 文庫的數據，展示了核心 MCP 概念，如基於文庫內容的資源表示、訪問數據的工具以及與 Obsidian API 的集成。

🚀 快速開始

本項目的使用需要一定的前置條件，並且要進行相應的設置。

先決條件

• Node.js v18+
• TypeScript 5.3+
• Obsidian API 密鑰（設置為 OBSIDIAN_API_KEY 環境變量）

設置

# 安裝依賴項
npm install

# 構建服務器
npm run build

# 使用自動重建啟動開發服務器
npm run watch

✨ 主要特性

資源

• 可通過 obsidian://server-info URI 訪問 Obsidian 服務器信息。
• 能獲取文庫內容及其元數據。
• 支持 JSON 格式，便於輕鬆集成。

工具

• get_vault_contents - 檢索 Obsidian 文庫的內容。
  • 接受路徑作為可選參數（默認：根目錄）。
  • 返回結構化的 JSON 響應。

API 集成

• 通過 HTTPS 實現與 Obsidian API 的安全連接。
• 帶有錯誤處理的自定義 axios 客戶端。
• 支持 Windows 路徑規範化。

📦 安裝指南

要與 Claude Desktop 一起使用，請添加服務器配置：

• 在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
• 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "/path/to/obsidian-mcp/build/index.js",
      "env": {
        "OBSIDIAN_API_KEY": "your-api-key-here"
      }
    }
  }
}

📚 詳細文檔

項目統計數據

• 總代碼行數：345 行
• 主要文件：
  • src/tool-handlers.ts（76 行）
  • src/resource-handlers.ts（45 行）
  • src/server.ts（32 行）
  • src/api-client.ts（25 行）

目錄結構

obsidian-mcp/
├── .codegpt/
│   └── head
├── src/
│   ├── api-client.ts
│   ├── index.ts
│   ├── resource-handlers.ts
│   ├── server.ts
│   └── tool-handlers.ts
├── .SourceSageignore
├── package.json
├── README.md
└── tsconfig.json

依賴項

運行時

• @modelcontextprotocol/sdk：MCP 服務器實現
• axios：HTTP 客戶端用於 API 通信

開發

• @types/node：Node.js 的 TypeScript 定義
• typescript：TypeScript 編譯器

🔧 技術細節

本項目基於 TypeScript 構建，通過與 Obsidian API 的集成，實現了對 Obsidian 文庫內容的訪問和管理。在資源表示方面，利用 Obsidian 文庫內容進行資源建模；在工具實現上，提供瞭如 get_vault_contents 這樣的實用工具；在 API 集成時，使用自定義的 axios 客戶端，通過 HTTPS 與 Obsidian API 進行安全通信，並對 Windows 路徑進行規範化處理。

💻 使用示例

基礎用法

在完成項目的設置和安裝後，可以使用以下命令啟動項目：

npm run watch

此命令會啟動開發服務器，並在代碼發生變化時自動重建。

高級用法

若要進行調試，我們推薦使用 MCP Inspector：

npm run inspector

Inspector 將提供一個 URL，用於在瀏覽器中訪問調試工具。