使用说明

项目简介

Claudesidian MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在将您的 Obsidian 知识库转化为一个强大的上下文服务后端。它允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议访问和操作您 Obsidian vault 中的笔记资源，并利用服务器提供的工具扩展 LLM 的功能。通过 Claudesidian，您可以构建基于个人知识库的智能应用，例如智能助手、知识检索工具等。

主要功能点

资源管理: 通过 MCP 协议将 Obsidian vault 中的笔记作为资源进行管理和访问。
模糊搜索: 提供在 Obsidian vault 中进行高效模糊搜索的能力，快速定位相关笔记。
网页抓取: 集成网页抓取工具，可以将网页内容保存为笔记，扩展知识库的信息来源。
笔记操作: 支持创建和编辑 Obsidian 笔记，方便 LLM 客户端进行知识的存储和更新。
记忆管理: 提供记忆管理工具，帮助 LLM 客户端记录和检索重要的交互信息。
推理支持: 集成推理工具，支持 LLM 客户端进行复杂的推理和问题解决。
关系管理: 提供人际关系管理工具，帮助 LLM 客户端记录和维护人际关系网络。

安装步骤

环境准备: 确保您的系统已安装以下软件：
- Python 3.9+
- Git
- Playwright (用于网页抓取功能)

克隆仓库: 使用您喜欢的 IDE (如 Visual Studio Code) 克隆仓库到本地：

https://github.com/Synaptic-Labs-AI/claudesidian.git

配置 'claude_desktop_config.json': 编辑 'claude_desktop_config.json' 文件，配置 Obsidian vault 的路径。请将 'PATH_TO_YOUR_OBSIDIAN_VAULT' 替换为您的 Obsidian vault 目录的实际路径。

{
  "mcpServers": {
    "claudesidian": {
      "command": "claudesidian",
      "args": [
        "PATH_TO_YOUR_OBSIDIAN_VAULT"
      ]
    }
  }
}

安装依赖: 打开终端，进入仓库根目录，运行以下命令安装项目依赖和 Playwright：

pip install -e .
playwright install

服务器配置

对于 MCP 客户端，您需要配置以下 JSON 信息以连接到 Claudesidian MCP 服务器。这通常在客户端的设置或配置文件中完成。

{
  "serverName": "claudesidian",  // 服务器名称，在客户端中用于标识和选择服务器
  "command": "claudesidian",    // 启动服务器的命令，确保 'claudesidian' 命令在您的系统 PATH 中可用
  "args": [                     // 启动命令的参数列表
    "PATH_TO_YOUR_OBSIDIAN_VAULT" // Obsidian vault 的绝对路径，请替换为您的实际路径
  ]
}

参数说明:

'serverName': 服务器的名称，客户端使用此名称来引用和管理不同的 MCP 服务器连接。您可以自定义名称，例如 "my_obsidian_server"。
'command': 启动 Claudesidian 服务器的可执行命令。安装成功后，'claudesidian' 命令应该可以直接在终端中运行。
'args': 传递给 'claudesidian' 命令的参数列表。
- 唯一必需的参数是 Obsidian vault 的路径。请将 '"PATH_TO_YOUR_OBSIDIAN_VAULT"' 替换为您的 Obsidian vault 在您本地文件系统中的绝对路径。例如，在 macOS 上可能是 '"/Users/YourUsername/Documents/MyObsidianVault"'，在 Windows 上可能是 '"C:\Users\YourUsername\ObsidianVault"'.

基本使用方法

启动服务器: 在终端中，使用以下命令启动 Claudesidian MCP 服务器，将 'PATH_TO_YOUR_OBSIDIAN_VAULT' 替换为您的 Obsidian vault 目录的实际路径：
```
claudesidian "PATH_TO_YOUR_OBSIDIAN_VAULT"
```
服务器成功启动后，将在终端输出相关日志信息。
连接客户端: 配置您的 MCP 客户端，使用上述 服务器配置 中提供的 JSON 信息连接到 Claudesidian MCP 服务器。具体的客户端配置方法请参考您使用的 MCP 客户端的文档。
使用工具: 客户端连接成功后，您可以使用客户端提供的界面或命令来调用 Claudesidian 服务器提供的各种工具，例如搜索笔记、抓取网页、创建记忆等。具体可用的工具列表请参考仓库 README.md 文件中的 "Available Tools" 章节。

注意:

启动服务器前，请确保您已正确配置 'claude_desktop_config.json' 文件，并安装了所有依赖。
首次运行服务器可能需要一些时间来初始化 vault 索引。
服务器运行时会在终端输出日志信息，用于监控服务器状态和排查问题。

关键词