使用说明

项目简介

Obsidian-brain 是一个 MCP (Model Context Protocol) 服务器，旨在将大型语言模型客户端（如 Claude）与您的 Obsidian 知识库连接起来。通过提供一系列工具，Obsidian-brain 允许 LLM 客户端以结构化和标准化的方式访问和操作您在 Obsidian 中存储的个人知识和信息。

主要功能点

记忆检索 (fetch-memories): 使用关键词和语义混合搜索技术，在您的 Obsidian Vault 中快速查找相关笔记，帮助 LLM 理解上下文并获取信息。
添加笔记 (add-note): 允许 LLM 客户端直接在您的 Obsidian Vault 中创建新的笔记，方便记录对话摘要、想法或其他重要信息。
保存对话 (save-conversation): 可以将与 LLM 的完整对话过程保存为 Obsidian 中的笔记，方便回顾和存档。
追踪对话 (track-conversation): 在对话过程中记录消息，为保存对话功能提供数据支持。

安装步骤

Obsidian-brain MCP 服务器本身无需单独安装。它被设计为通过 MCP 客户端（例如 Claude 桌面应用）启动和运行。您只需要配置您的 MCP 客户端以连接到此服务器即可。

服务器配置 (Claude 桌面应用)

要将 Obsidian-brain 集成到 Claude 桌面应用，您需要编辑 Claude 的配置文件 'claude_desktop_config.json'，并添加或修改 'mcpServers' 部分。以下是配置示例，请根据您的实际情况进行调整：

{
  "mcpServers": {
    "obsidian-brain": {
      "command": "uvx",
      "args": [
        "[email protected]"
      ],
      "env": {
        "OBSIDIAN_MIND_PATH": "/path/to/your/obsidian/vault/" // 将 "/path/to/your/obsidian/vault/" 替换为您 Obsidian Vault 的实际路径
      }
    }
  }
}

配置参数说明:

server name: 'obsidian-brain' (服务器名称，用于在 MCP 客户端中标识和引用)
command: 'uvx' (启动服务器的命令，这里使用 'uvx' 运行 'obsidian-brain' 包)
args: '["[email protected]"]' (传递给 'command' 的参数，指定要运行的包名和版本)
env: (环境变量配置)
- OBSIDIAN_MIND_PATH: '/path/to/your/obsidian/vault/' (Obsidian Vault 的绝对路径，请务必替换为您的实际路径)

注意: 请确保您已安装 'uvx' 包管理器，并且 'obsidian-brain' 包已发布到 PyPI 或本地可访问。如果使用开发模式，请参考仓库 README 中的开发配置。

基本使用方法

配置完成后，当您在 Claude 中与 LLM 对话时，Claude 将能够利用 Obsidian-brain 提供的工具。

例如:

当您想让 Claude 查找您在 Obsidian 中记录的关于某个主题的笔记时，您可以提问类似 "帮我搜索一下关于[主题名称]的笔记"。Claude 可能会调用 'fetch-memories' 工具来检索相关信息。
当您想记录一些新的想法或对话内容到 Obsidian 中时，您可以指示 Claude "帮我添加一个标题为[笔记标题]，内容为[笔记内容]的笔记"。Claude 可能会调用 'add-note' 工具来创建新笔记。
在对话结束后，您可以要求 Claude "保存这次对话到 Obsidian"，Claude 可能会调用 'save-conversation' 工具将对话记录保存为笔记。

具体工具的调用方式和效果取决于 LLM 客户端的实现和提示词设计。请参考 MCP 客户端 (如 Claude) 的文档以获取更详细的使用指南。

关键词