🚀 MCP 服务器 Obsidian Omnisearch
本项目是一个基于 FastMCP 的服务器，通过 REST API 接口为您提供 Obsidian 笔记库搜索功能，让您能更便捷地程序化搜索笔记。
🚀 快速开始
该项目实现了一个搜索服务，允许您程序化地搜索 Obsidian 笔记。它使用 FastMCP 将搜索功能作为工具公开，以便与其他服务集成。
✨ 主要特性
- 可搜索 Obsidian 笔记库中的笔记。
- 支持 REST API 集成。
- 能返回匹配笔记的绝对路径。
- 可与 FastMCP 工具轻松集成。
📦 安装指南
先决条件
- Python 3.x
- 安装并运行 Obsidian 及其 Omnisearch 插件
- FastMCP 库
- 激活状态的 Obsidian 笔记库
安装步骤
- 克隆仓库：
git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
cd mcp-server-obsidian-omnisearch
- 安装依赖项：
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%
开发/未发布的服务器配置
{
"mcpServers": {
"obsidian-omnisearch": {
"command": "uv",
"args": [
"--directory",
"/mcp-server-obsidian-omnisearch" ,
"run",
"mcp-server-obsidian-omnisearch",
"/path/to/your/obsidian/vault"
]
}
}
}
已发布的服务器配置
{
"mcpServers": {
"obsidian-omnisearch": {
"command": "uvx",
"args": [
"mcp-server-obsidian-omnisearch",
"/path/to/your/obsidian/vault"
]
}
}
}
📄 API 文档
搜索笔记
- 函数：
obsidian_notes_search(query: str) - 描述：搜索 Obsidian 笔记并返回匹配笔记的绝对路径
- 参数：
query：搜索查询字符串
- 返回：匹配笔记的绝对路径列表
🔧 技术细节
开发
构建和发布
为了准备分发包，可按以下步骤操作：
- 同步依赖项并更新锁定文件：
uv sync
- 构建包分布：
uv build
这将在 dist/ 目录中创建源代码和轮式（wheel）发行版。
- 发布到 PyPI：
uv publish
注意：您需要通过环境变量或命令行参数设置 PyPI 凭据：
- 令牌：
--token或UV_PUBLISH_TOKEN - 用户名：
--user或UV_PUBLISH_USER - 密码：
--password或UV_PUBLISH_PASSWORD
💡 使用建议
如果您在使用过程中遇到任何问题或有其他疑问，请随时与我们联系。