Anpigon MCP Server Obsidian Omnisearch

🚀 MCP 服務器 Obsidian Omnisearch

本項目是一個基於 FastMCP 的服務器，藉助 REST API 接口為您提供 Obsidian 筆記庫搜索功能，讓您能更便捷地程序化搜索筆記。

🚀 快速開始

本項目實現了一個搜索服務，允許您程序化地搜索 Obsidian 筆記。它使用 FastMCP 將搜索功能作為工具公開，以便與其他服務集成。

✨ 主要特性

• 🔍 可搜索 Obsidian 筆記庫中的筆記。
• 🌐 支持 REST API 集成。
• 📁 返回匹配筆記的絕對路徑。
• 🛠️ 能與 FastMCP 工具輕鬆集成。

📦 安裝指南

先決條件

• Python 3.x
• 安裝並運行 Obsidian 及其 Omnisearch 插件
• FastMCP 庫
• 激活狀態的 Obsidian 筆記庫

安裝步驟

1. 克隆倉庫：

git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
cd mcp-server-obsidian-omnisearch

2. 安裝依賴項：

uv install

💻 使用示例

Obsidian Omnisearch API

您需要運行 Obsidian Omnisearch 社區插件：https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine

Claude Desktop

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

{
  "mcpServers": {
    "obsidian-omnisearch": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-server-obsidian-omnisearch",
        "run",
        "mcp-server-obsidian-omnisearch",
        "/path/to/your/obsidian/vault"
      ]
    }
  }
}

{
  "mcpServers": {
    "obsidian-omnisearch": {
      "command": "uvx",
      "args": [
        "mcp-server-obsidian-omnisearch",
        "/path/to/your/obsidian/vault"
      ]
    }
  }
}

📚 詳細文檔

配置

Obsidian 筆記庫路徑現在作為運行服務器時的命令行參數提供：

python server.py /path/to/your/obsidian/vault

API 參考

搜索筆記

• 函數：obsidian_notes_search(query: str)
• 描述：搜索 Obsidian 筆記並返回匹配筆記的絕對路徑
• 參數：
  • query：搜索查詢字符串
• 返回：匹配筆記的絕對路徑列表

開發

構建和發佈

為了準備分發包：

1. 同步依賴項並更新鎖定文件：

uv sync

2. 構建包分佈：

uv build

這將在 dist/ 目錄中創建源代碼和輪式（wheel）發行版。

3. 發佈到 PyPI：

uv publish

注意：您需要通過環境變量或命令行參數設置 PyPI 憑據：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 用戶名：--user 或 UV_PUBLISH_USER
• 密碼：--password 或 UV_PUBLISH_PASSWORD

📄 注意事項

如果您在使用過程中遇到任何問題或有其他疑問，請隨時與我們聯繫。