使用说明

项目简介

本项目是一个 MCP 服务器，旨在桥接大型语言模型 (LLM) 客户端与 Obsidian 笔记应用。通过此服务器，LLM 能够安全地访问和操作存储在 Obsidian 笔记库中的信息，实现如内容检索、编辑等功能，从而扩展 LLM 在知识管理和个人助理领域的应用。

主要功能点

文件管理: 列出 Obsidian 笔记库中的文件和目录。
内容获取: 获取指定 Obsidian 文件的内容。
内容搜索: 在 Obsidian 笔记库中进行关键词或复杂条件搜索。
内容编辑: 向 Obsidian 文件追加或修改内容。

安装步骤

安装 Obsidian REST API 插件:
- 在 Obsidian 应用中，安装并启用 "Local REST API" 社区插件 (https://github.com/coddingtonbear/obsidian-local-rest-api)。
- 在插件设置中获取 API 密钥 (API Key)。
安装 MCP 服务器:
- 下载或克隆此 GitHub 仓库的代码到本地。
- 使用 'uv pip install .' 或 'pip install .' 命令在仓库根目录下安装 Python 包依赖。 (需要预先安装 uv 或 pip)
配置 Obsidian API 密钥:
- 方法一 (推荐): 在 MCP 客户端的服务器配置中设置环境变量 'OBSIDIAN_API_KEY'，并将您的 Obsidian API 密钥填入。
- 方法二: 在 MCP 服务器的工作目录下创建 '.env' 文件，并添加 'OBSIDIAN_API_KEY=您的API密钥' (请替换为实际的 API 密钥)。

服务器配置 (MCP 客户端配置)

要使 MCP 客户端 (例如 Claude Desktop) 连接到此 MCP 服务器，您需要在客户端的服务器配置中添加如下 JSON 配置信息。请根据您的 MCP 客户端的具体配置方法进行添加。

{
  "server_name": "obsidian-server",
  "command": "uvx",
  "args": [
    "mcp-obsidian"
  ],
  "env": {
    "OBSIDIAN_API_KEY": "<YOUR_OBSIDIAN_API_KEY>"
  }
}

'server_name': 为您的服务器配置自定义一个名称，例如 "obsidian-server"，用于在 MCP 客户端中标识和选择此服务器。
'command': 启动 MCP 服务器的命令。 'uvx' 通常用于执行已安装的 Python 包提供的可执行程序。如果您使用 'pip' 安装，并且希望直接运行脚本，可能需要调整为 'python' 或 'python3'，并指定脚本路径。
'args': 传递给启动命令的参数。 'mcp-obsidian' 是此 MCP 服务器的入口程序名称。
'env': 环境变量配置。 'OBSIDIAN_API_KEY' 是连接 Obsidian REST API 所必需的密钥，请务必替换 '<YOUR_OBSIDIAN_API_KEY>' 为您在 Obsidian REST API 插件中获取的实际 API 密钥。

基本使用方法

确保 Obsidian 应用已启动，并且 "Local REST API" 插件正在运行。
启动 MCP 客户端，并确保已正确配置上述服务器信息。
在 LLM 客户端中，指示 LLM 使用您配置的 "obsidian-server" (或您自定义的 'server_name') 来访问和操作 Obsidian 笔记。例如，您可以向 LLM 发出指令，如 "使用 obsidian-server 列出我 Obsidian 笔记库中的所有文件"，或 "使用 obsidian-server 搜索包含 '项目计划' 的笔记内容"。
LLM 将会调用 MCP 服务器提供的工具，与 Obsidian 进行交互，并返回结果给您。

关键词