Obsidian Index MCP Server

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Handles notes in Markdown format, exposing them with the 'text/markdown' media type for search and access.

  • Provides semantic search over Obsidian vaults and exposes recently modified notes as resources, allowing access to Markdown notes within Obsidian knowledge bases.

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 :黑曜石保险库的路径(可以多次指定)
  • --database :本地数据库文件的路径(如果不存在则创建)
  • --reindex :重新索引保管库中的所有笔记(您现在可能每次都需要这样做)
  • --watch :监视保险库中的变化并相应地更新索引

快速入门

安装

克劳德桌面

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

发展

构建和发布

准备分发包:

  1. 同步依赖项并更新锁文件:
uv sync
  1. 构建软件包分发版:
uv build

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

  1. 发布到 PyPI:
uv publish

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

  • 令牌: --tokenUV_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

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

-
security - not tested
F
license - not found
-
quality - not tested

提供对 Obsidian 保险库的语义搜索功能,并通过 MCP 协议将最近的笔记作为资源公开给 Claude。

  1. Components
    1. Resources
    2. Tools
  2. Run the server
    1. Quickstart
      1. Install
    2. Development
      1. Building and Publishing
      2. Debugging
    ID: 1mr561pxj8