MCP Server Obsidian Omnisearch

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

概述

该项目实现了一个搜索服务，允许您通过编程方式搜索Obsidian保险库中的笔记。它使用FastMCP将搜索功能暴露为可以与其他服务集成的工具。

特性

• 搜索Obsidian保险库中的笔记
• 支持REST API集成
• 返回匹配笔记的绝对路径
• 与FastMCP工具轻松集成

预备条件

• Python 3.x
• 安装并运行了Omnisearch插件的Obsidian
• FastMCP库
• 活动的Obsidian保险库

安装

通过Smithery安装

要通过Smithery自动安装MCP Server Obsidian Omnisearch到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

2. 安装依赖项：

uv install

配置

在运行服务器时，现在可以通过命令行参数提供Obsidian保险库路径：

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. 同步依赖项并更新锁文件：

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服务器通过标准I/O运行，调试可能会很困难。为了获得最佳的调试体验，我们强烈建议使用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。 </中文翻译>