Obsidian Index MCP server

Obsidian Index MCP 服务

一个 MCP 服务，可对 Obsidian 库进行语义搜索，并将最近的笔记作为资源提供。

组件

资源

该服务会将库中最近修改的笔记作为资源提供给 MCP 客户端。

• 笔记使用 obsidian://<VAULT_NAME>/<NOTE_PATH> URL 方案寻址
• 笔记的媒体类型为 text/markdown

工具

该服务实现了一个工具：

• search-notes：对已索引的笔记进行语义搜索

运行服务

uv run obsidian-index mcp --vault <VAULT_PATH> --database <DATABASE_PATH> --reindex --watch

• --vault：Obsidian 库的路径（可多次指定）
• --database：本地数据库文件的路径（如果文件不存在，则会创建）
• --reindex：重新索引库中的所有笔记（目前你可能每次都需要使用此选项）
• --watch：监视库中的更改并相应地更新索引

快速入门

安装

Claude Desktop

在 MacOS 上：~/Library/Application\ Support/Claude/claude_desktop_config.json 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

开发/未发布服务配置

``` "mcpServers": { "obsidian-index": { "command": "uv", "args": [ "--directory", "", "run", "obsidian-index", "--database", "", "--vault", "", "--reindex", "--watch" ] } } ```

已发布服务配置

``` "mcpServers": { "obsidian-index": { "command": "uvx", "args": [ "obsidian-index", "--database", "", "--vault", "", "--reindex", "--watch" ] } } ```

开发

构建和发布

准备分发软件包：

1. 同步依赖项并更新锁定文件：

uv sync

2. 构建软件包分发文件：

uv build

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

3. 发布到 PyPI：

uv publish

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

• 令牌：--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_PROJECT> run obsidian-index

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