使用说明

项目简介

Obsidian MCP Tool Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型（LLM）客户端提供访问和操作 Obsidian vault 中笔记的能力。通过此服务器，LLM 客户端可以安全、可扩展地与您的 Obsidian 知识库进行交互，实现笔记内容读取、编辑、元数据管理、搜索以及日常笔记管理等功能。

主要功能点

笔记内容读写: 允许 LLM 客户端读取和写入 Obsidian vault 中的笔记内容。
元数据管理: 支持读取和更新笔记的元数据 (Frontmatter)。
文件和文件夹操作: 提供列出文件夹和笔记的功能，方便 LLM 客户端浏览 vault 结构。
内容和元数据搜索: 支持根据关键词搜索笔记内容和元数据，帮助 LLM 客户端快速定位信息。
日常笔记管理: 允许 LLM 客户端创建和追加内容到日常笔记。
链接和标签提取: 支持获取笔记中的外链、反链以及所有标签，增强 LLM 对笔记之间关系的理解。

安装步骤

克隆仓库: 如果尚未克隆，请先克隆 GitHub 仓库到本地。
进入项目目录: 使用命令行工具切换到项目根目录 'obsidian-mcp'。
创建并激活虚拟环境: 推荐使用虚拟环境以隔离项目依赖，避免与其他 Python 项目冲突。
- 创建虚拟环境：'python -m venv .venv'
- 激活虚拟环境：
  - Windows (PowerShell): '.venv\Scripts\Activate.ps1'
  - Linux/macOS: 'source .venv/bin/activate'
安装依赖: 在虚拟环境中，使用 pip 安装项目及其依赖：'pip install .'

服务器配置

MCP 客户端需要配置服务器的启动命令和参数才能连接。以下是配置 Claude Desktop 等 MCP 客户端的 JSON 格式配置示例。请根据您的实际路径进行修改。

{
  "mcpServers": {
    "obsidian_vault": {
      "command": "/path/to/your/obsidian-mcp/.venv/bin/python",  // 【请替换为您的 python 路径】虚拟环境中的 Python 解释器路径 (Linux/macOS 示例)
      // "command": "C:\\path\\to\\your\\obsidian-mcp\\.venv\\Scripts\\python.exe", // 【请替换为您的 python 路径】虚拟环境中的 Python 解释器路径 (Windows 示例)
      "args": [
        "/path/to/your/obsidian-mcp/obsidian_mcp_server/main.py" // 【请替换为您的 main.py 路径】服务器 main.py 脚本路径 (Linux/macOS 示例)
        // "args": ["C:\\path\\to\\your\\obsidian-mcp\\obsidian_mcp_server\\main.py"]  // 【请替换为您的 main.py 路径】服务器 main.py 脚本路径 (Windows 示例)
      ],
      "env": {
        "OMCP_VAULT_PATH": "/path/to/your/Obsidian/Vault" // 【请替换为您的 Obsidian Vault 路径】Obsidian Vault 的绝对路径 (Linux/macOS 示例)
        // "OMCP_VAULT_PATH": "C:/path/to/your/Obsidian/Vault"  // 【请替换为您的 Obsidian Vault 路径】Obsidian Vault 的绝对路径 (Windows 示例)
      }
    }
  }
}

配置参数说明:

command: 指向 Python 解释器的绝对路径，必须是您在安装步骤中创建的虚拟环境中的 Python 解释器。
args: 包含服务器 'main.py' 脚本路径的列表。请替换为 'main.py' 文件的实际绝对路径。
env: 环境变量配置，'OMCP_VAULT_PATH' 是必须配置的 Obsidian Vault 绝对路径。请替换为您的 Obsidian Vault 的实际路径。

重要提示:

请将上述配置示例中的 '/path/to/your/obsidian-mcp' 和 '/path/to/your/Obsidian/Vault' 替换为您系统上的实际绝对路径。
'command' 必须指向虚拟环境中的 'python' 或 'python.exe'。
配置完成后，您需要在 MCP 客户端应用程序中加载或重启配置才能生效。

基本使用方法

Obsidian MCP Tool Server 本身是一个后台服务器，您不需要直接操作它。服务器启动后，它会监听来自 MCP 客户端的请求。您需要在支持 MCP 协议的客户端（如 Claude Desktop）中配置并连接到此服务器，然后通过客户端来利用服务器提供的各项 Obsidian 功能。

关键词