使用说明

项目简介

Claudesidian MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 客户端提供与其 Obsidian 知识库进行交互的能力。通过 Claudesidian MCP Server，LLM 客户端可以安全、高效地访问和操作存储在 Obsidian vault 中的笔记、数据和信息，从而实现更智能化的应用。

主要功能点

资源访问: 允许 LLM 客户端访问和检索 Obsidian vault 中的笔记内容，作为上下文信息。
工具调用: 提供多种工具，例如：
- 推理工具 (Reasoning Tool): 用于管理推理流程，辅助 LLM 进行复杂问题求解。
- 创建记忆工具 (CreateMemory Tool): 在交互结束后，将重要信息存储为记忆笔记。
- 模糊搜索工具 (FuzzySearch Tool): 在 Obsidian vault 中执行快速模糊搜索，查找相关笔记。
- 网页抓取工具 (ScrapeWebsite Tool): 抓取授权的网页内容并将其存档为笔记。
- 创建笔记工具 (CreateNote Tool): 在 Obsidian vault 中创建新笔记。
- 编辑笔记工具 (EditNote Tool): 编辑 Obsidian vault 中已存在的笔记。
- 记忆检索工具 (MemoryRetrieval Tool): 根据查询从 vault 中检索和整合记忆笔记。
- 关系管理工具 (Relationships Tool): 管理笔记或实体间的关系信息。
Prompt 模板: 虽然仓库文档未明确提及 Prompt 模板功能，但 MCP 服务器的定义包含此项，且工具设计为 LLM 交互提供上下文，暗示支持通过工具和资源定制 Prompt。

安装步骤

克隆仓库: 使用 IDE (例如 Visual Studio Code) 克隆仓库到本地。
- 在 IDE 中选择克隆仓库功能。
- 输入仓库 URL: 'https://github.com/MCP-Mirror/Synaptic-Labs-AI_claudesidian'。
- 选择本地目录保存项目。
- 克隆完成后，在 IDE 中打开项目文件夹。

配置 'claude_desktop_config.json': 编辑 'claude_desktop_config.json' 文件，更新 Obsidian vault 的路径。

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

将 'PATH_TO_YOUR_OBSIDIAN_VAULT' 替换为您的 Obsidian vault 目录的实际路径。例如：'/Users/YourUsername/ObsidianVault' (macOS/Linux) 或 'C:\Users\YourUsername\ObsidianVault' (Windows)。

安装依赖: 打开终端，导航到项目根目录，运行以下命令安装 Python 依赖和 Playwright。
```
pip install -e .
playwright install
```
运行服务器: 在终端中，使用以下命令启动 Claudesidian MCP Server。
```
claudesidian "PATH_TO_YOUR_OBSIDIAN_VAULT"
```
- 同样，将 'PATH_TO_YOUR_OBSIDIAN_VAULT' 替换为您的 Obsidian vault 目录的实际路径。

服务器配置

MCP 客户端需要配置 Claudesidian MCP Server 的连接信息。以下是一个 'claude_desktop_config.json' 示例配置，用于指导 MCP 客户端如何连接到 Claudesidian 服务器：

{
  "mcpServers": {
    "claudesidian": {
      "serverName": "Claudesidian MCP Server",  // 服务器名称，客户端显示用
      "command": "claudesidian",  // 启动服务器的命令
      "args": [  // 启动命令的参数
        "PATH_TO_YOUR_OBSIDIAN_VAULT"  //  <请替换为您的 Obsidian Vault 绝对路径>
      ]
    }
  }
}

基本使用方法

确保 Claudesidian MCP Server 成功启动并运行。
配置 MCP 客户端，使其能够连接到 Claudesidian MCP Server。通常需要在客户端软件中配置 'claude_desktop_config.json' 文件或提供相应的服务器连接信息。
在 MCP 客户端中，可以调用 Claudesidian MCP Server 提供的工具，例如：
- 使用 "search" 工具在 Obsidian vault 中进行模糊搜索。
- 使用 "scrape" 工具抓取网页内容并保存到 vault。
- 使用 "create_memory" 工具将重要信息存储为记忆笔记。
- 使用 "reasoning" 工具启动推理流程。
- 使用 "create_note" 和 "edit_note" 工具管理笔记。
- 使用 "relationship" 工具管理人际关系信息。
LLM 客户端可以通过 MCP 协议与 Claudesidian MCP Server 交互，利用这些工具和资源来增强其上下文理解和功能执行能力。

注意

请确保您的 Obsidian vault 路径配置正确，并且服务器进程有权限访问该目录。
首次运行服务器可能需要一些时间来索引您的 Obsidian vault 内容。
查阅仓库的 README.md 文件和代码注释以获取更详细的信息和高级用法。

关键词

使用说明

信息