MCP Server Obsidian Omnisearch

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

概述

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

特性

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

前提条件

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

安装

通过Smithery安装

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

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

手动安装

1. 克隆仓库：
   bash
   git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
   cd mcp-server-obsidian-omnisearch

2. 安装依赖项：
   bash
   uv install

配置

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

bash
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

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

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

API参考

搜索笔记

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

开发

构建和发布

准备分发包：

1. 同步依赖项并更新锁文件：
   bash
   uv sync

2. 构建包分发：
   bash
   uv build

这将在dist/目录中创建源码和轮子分发。

1. 发布到PyPI：
   bash
   uv publish

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

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

调试

由于MCP服务器通过标准输入输出运行，调试可能会很困难。为了获得最佳调试体验，我们强烈建议使用MCP Inspector。

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

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

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

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

bash
tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-server-obsidian-omnisearch.log## 依赖项

• FastMCP
• requests
• urllib

许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

贡献

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