AI导哈

Obsidian笔记搜索服务

一个基于FastMCP的服务，通过REST API接口提供Obsidian笔记库的搜索功能。

  • by anpigon
  • Python
  • 本地部署
  • 30 星标
  • 更新于
在 GitHub 查看 anpigon/mcp-server-obsidian-omnisearch

使用说明

MCP服务器黑曜石Omnisearch

一个基于FastMCP的服务器，通过REST API接口提供Obsidian vault搜索功能。

概述

此项目实现了一个搜索服务，允许您以编程方式搜索黑曜石金库笔记。它使用FastMCP将搜索功能作为可以与其他服务集成的工具公开。

特性

  • 搜索黑曜石金库笔记
  • REST API集成
  • 返回匹配笔记的绝对路径
  • 与FastMCP工具轻松集成

先决条件

  • Python 3.x
  • 安装并运行Omnisearch插件的黑曜石
  • FastMCP库
  • 活性黑曜石拱顶

安装

通过Smithery安装

通过以下方式自动安装MCP Server Obsidian Omnisearch for Claude Desktop 史密瑟里:

npx -y @smithery/cli install @anpigon/mcp-server-obsidian-omnisearch --client claude

手动安装

  1. 克隆存储库：
git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
cd mcp-server-obsidian-omnisearch
  1. 安装依赖项：
uv install

配置

运行服务器时，黑曜石保管库路径现在作为命令行参数提供：

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

用法

Obsidian Omnisearch API

您需要运行Obsidian Omnisearch社区插件：https://publish.obsidian.md/omnisearch/Inject+全方位搜索+结果+进入+你的+搜索+引擎

克劳德桌面

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

在Windows上： %APPDATA%/Claude/claude_desktop_config.json

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

api参考

搜索笔记

  • 功能： obsidian_notes_search(query: str)
  • 描述：搜索黑曜石笔记并返回匹配笔记的绝对路径
  • 参数：
    • query：搜索查询字符串
  • 返回：匹配笔记的绝对路径列表

发展

建筑与出版

准备分发包裹：

  1. 同步依赖关系并更新锁文件：
uv sync
  1. 构建包分发：
uv build

这将在 dist/ 目录。

  1. 发布到PyPI：
uv publish

注意：您需要通过环境变量或命令标志设置PyPI凭据：

  • 令牌： --token 或 UV_PUBLISH_TOKEN
  • 或用户名/密码： --username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

调试

由于MCP服务器在stdio上运行，调试可能具有挑战性。为了达到最佳调试效果 经验，我们强烈建议使用 MCP检查员.

您可以通过以下方式启动MCP检查器 npm 使用此命令：

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-server-obsidian-omnisearch run mcp-server-obsidian-omnisearch

启动后，检查器将显示一个URL，您可以在浏览器中访问该URL以开始调试。

您还可以使用以下命令查看服务器日志：

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-server-obsidian-omnisearch.log

依赖项

  • FastMCP
  • 请求：
  • urllib

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

贡献

欢迎投稿！请随时提交拉取请求。

相关 MCP