Obsidian Index MCP服务器

这是一个提供Obsidian保险库语义搜索功能的MCP服务器，并将最近修改的笔记作为资源公开。

组件

资源

该服务器将保险库中最近修改的笔记作为资源公开给MCP客户端。

• 笔记通过obsidian://<保险库名称>/<笔记路径>URL方案进行定位
• 笔记的媒体类型为text/markdown

工具

该服务器实现了一个工具：

• search-notes：在索引过的笔记上执行语义搜索

运行服务器

uv run obsidian-index mcp --vault <保险库路径> --database <数据库路径> --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

<details> <summary>开发/未发布的服务器配置</summary> ``` "mcpServers": { "obsidian-index": { "command": "uv", "args": [ "--directory", "<项目路径>", "run", "obsidian-index", "--database", "<数据库路径>", "--vault", "<保险库路径>", "--reindex", "--watch" ] } } ``` </details> <details> <summary>已发布的服务器配置</summary> ``` "mcpServers": { "obsidian-index": { "command": "uvx", "args": [ "obsidian-index", "--database", "<数据库路径>", "--vault", "<保险库路径>", "--reindex", "--watch" ] } } ``` </details>

开发

构建与发布

为了准备分发包：

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服务器通过标准输入输出运行，调试可能会比较困难。为了获得最佳的调试体验，我们强烈推荐使用MCP Inspector。

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

npx @modelcontextprotocol/inspector uv --directory <项目路径> run obsidian-index

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