Obsidian Index MCP server

Obsidian Index MCP server

site icon
2024.12.13 5
Python语义搜索知识管理Obsidian 集成内容生成开发效率
mcp-obsidian-index 是一个 MCP 服务器,专门为 Obsidian 知识库提供语义搜索功能,并将最近修改的笔记作为资源暴露给 MCP 客户端。它能够索引 Obsidian 库中的笔记,并通过特定的 URL 方案进行访问和搜索。
View on GitHub

Overview

基本能力

产品定位

mcp-obsidian-index 是一个专为 Obsidian 用户设计的 MCP 服务器,旨在提升知识管理和检索的效率。

核心功能

  • 语义搜索:通过 search-notes 工具对索引的笔记进行语义搜索。
  • 资源暴露:将最近修改的笔记作为资源暴露给 MCP 客户端,支持 obsidian://<VAULT_NAME>/<NOTE_PATH> URL 方案。
  • 自动索引:支持监视库中的变化并自动更新索引。

适用场景

  • 需要快速检索 Obsidian 知识库中的内容。
  • 需要将 Obsidian 笔记集成到其他 MCP 客户端应用中。
  • 开发者需要调试和测试 Obsidian 笔记的语义搜索功能。

工具列表

  • search-notes:执行对索引笔记的语义搜索。

常见问题解答

  • 如何调试:推荐使用 MCP Inspector 进行调试,通过 npx @modelcontextprotocol/inspector 启动。

使用教程

使用依赖

确保已安装 Python 和 uv 工具。

安装教程

  1. 运行以下命令启动服务器:
uv run obsidian-index mcp --vault <VAULT_PATH> --database <DATABASE_PATH> --reindex --watch

参数说明: - --vault:Obsidian 库的路径(可多次指定)。 - --database:本地数据库文件的路径(不存在则创建)。 - --reindex:重新索引库中的所有笔记。 - --watch:监视库中的变化并更新索引。

调试方式

使用 MCP Inspector 进行调试:

npx @modelcontextprotocol/inspector uv --directory <PATH_TO_PROJECT> run obsidian-index

许可证

None