MCP Server Obsidian Omnisearch

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

概述

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

特性

• 搜索 Obsidian vault 笔记
• REST API 集成
• 返回匹配笔记的绝对路径
• 易于与 FastMCP 工具集成

前提条件

• Python 3.x
• 安装并运行了 Omnisearch 插件的 Obsidian
• FastMCP 库
• 活跃的 Obsidian vault

安装

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 MCP Server Obsidian Omnisearch：

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

2. 安装依赖：

uv install

配置

Obsidian vault 路径现在作为命令行参数在运行服务器时提供：

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

用法

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

<details> <summary>开发/未发布的服务器配置</summary>

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

</details>

<details> <summary>已发布的服务器配置</summary>

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

</details>

API 参考

搜索笔记

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

开发

构建和发布

要准备用于分发的软件包：

1. 同步依赖并更新 lockfile：

uv sync

2. 构建软件包分发：

uv build

这将在 dist/ 目录中创建源和 wheel 分发。

3. 发布到 PyPI：

uv publish

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

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

调试

由于 MCP 服务器通过 stdio 运行，因此调试可能具有挑战性。 为了获得最佳调试体验，我们强烈建议使用 MCP Inspector。

您可以使用以下命令通过 npm 启动 MCP Inspector：

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

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

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

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

依赖

• FastMCP
• requests
• urllib

许可证

本项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。

贡献

欢迎贡献！ 请随时提交 Pull Request。