local-only server
The server can only run on the client’s local machine because it depends on local resources.
Integrations
Provides searchable access to Obsidian vault notes through the Omnisearch plugin, returning absolute file paths to matching notes based on search queries
MCP 服务器 Obsidian Omnisearch
基于 FastMCP 的服务器,通过 REST API 接口提供 Obsidian 保险库搜索功能。
概述
该项目实现了一项搜索服务,允许您以编程方式搜索 Obsidian 保险库笔记。它使用 FastMCP 将搜索功能公开为可与其他服务集成的工具。
特征
- 搜索黑曜石金库笔记
- REST API 集成
- 返回匹配注释的绝对路径
- 轻松与 FastMCP 工具集成
先决条件
- Python 3.x
- 安装并运行 Omnisearch 插件的 Obsidian
- FastMCP 库
- 活跃的黑曜石金库
安装
通过 Smithery 安装
要通过Smithery自动为 Claude Desktop 安装 MCP Server Obsidian Omnisearch:
手动安装
- 克隆存储库:
- 安装依赖项:
配置
现在,运行服务器时,Obsidian 保险库路径作为命令行参数提供:
用法
Obsidian Omnisearch API
您需要运行 Obsidian Omnisearch 社区插件: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine
克劳德桌面
在 MacOS 上: ~/Library/Application\ Support/Claude/claude_desktop_config.json
在 Windows 上: %APPDATA%/Claude/claude_desktop_config.json
API 参考
搜索笔记
- 函数:
obsidian_notes_search(query: str)
- 描述:搜索 Obsidian 笔记并返回匹配笔记的绝对路径
- 参数:
query
:搜索查询字符串
- 返回:匹配注释的绝对路径列表
发展
构建和发布
准备分发包:
- 同步依赖项并更新锁文件:
- 构建软件包分发版:
这将在dist/
目录中创建源和轮子分布。
- 发布到 PyPI:
注意:您需要通过环境变量或命令标志设置 PyPI 凭据:
- 令牌:
--token
或UV_PUBLISH_TOKEN
- 或用户名/密码:
--username
/UV_PUBLISH_USERNAME
和--password
/UV_PUBLISH_PASSWORD
调试
由于 MCP 服务器通过 stdio 运行,调试起来可能比较困难。为了获得最佳调试体验,我们强烈建议使用MCP Inspector 。
您可以使用以下命令通过npm
启动 MCP Inspector:
启动后,检查器将显示一个 URL,您可以在浏览器中访问该 URL 以开始调试。
您还可以使用以下命令查看服务器日志:
依赖项
- FastMCP
- 请求
- urllib
执照
该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅LICENSE文件。
贡献
欢迎贡献代码!欢迎提交 Pull 请求。
This server cannot be installed
通过 REST API 接口为 Obsidian 保险库提供编程搜索功能,允许外部应用程序搜索注释并检索匹配文档的绝对路径。
- Overview
- Features
- Prerequisites
- Installation
- Configuration
- Usage
- API Reference
- Development
- Dependencies
- License
- Contributing