使用说明

项目简介

Obsidian MCP REST Server 是一款 MCP (Model Context Protocol) 服务器，它充当 AI 助手与本地 Obsidian 知识库之间的桥梁。通过这个服务器，AI 助手可以安全、便捷地访问和操作您的 Obsidian 笔记，实现知识的检索和管理，从而增强 AI 助手在知识密集型任务中的能力。

主要功能点

Obsidian 知识库访问: 通过 MCP 协议，AI 助手可以连接到您的本地 Obsidian 知识库。
笔记内容管理: 支持读取指定路径笔记的内容，以及创建或更新笔记内容。
知识检索: 允许 AI 助手根据关键词在 Obsidian 知识库中搜索相关笔记。
目录浏览: 可以列出 Obsidian 知识库中所有笔记，或指定文件夹下的笔记列表。
元数据获取: 支持获取指定笔记的元数据信息。
本地安全: 服务器运行在本地，所有数据交互都在本地进行，保障数据安全。
工具集成: 内置一系列工具 (Tools)，如 'readNote', 'writeNote', 'searchNotes', 'listNotes', 'getMetadata'，供 AI 助手调用。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js 16 或更高版本。
安装 Obsidian Local REST API 插件: 在 Obsidian 中安装并启用 Local REST API 插件，并配置 API 端口（默认为 27123）和生成 API 密钥。

安装 Obsidian MCP REST Server: 打开终端，运行以下命令全局安装本 MCP 服务器：

npm install -g PublikPrinciple/obsidian-mcp-rest

创建配置文件 'config.json': 在您希望运行服务器的目录下创建 'config.json' 文件，并根据您的 Obsidian Local REST API 插件配置进行编辑，填入 API 密钥、端口等信息。示例如下：

{
  "obsidian": {
    "apiKey": "your-api-key-here",  // 替换为您的 Obsidian Local REST API 密钥
    "port": 27123,                  // Obsidian Local REST API 端口，默认为 27123
    "host": "localhost"             // Obsidian Local REST API 主机地址，通常为 localhost
  },
  "server": {
    "name": "obsidian-mcp",        // MCP 服务器名称，可自定义
    "version": "1.0.0"             // MCP 服务器版本
  }
}

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

对于需要连接此 MCP 服务器的 MCP 客户端，您需要配置服务器的启动命令和参数。以下是一个典型的 JSON 配置示例，您需要将其添加到 MCP 客户端的服务器配置中：

{
  "name": "obsidian-mcp",                       // MCP 服务器名称，与 config.json 中 server.name 一致
  "command": "obsidian-mcp-rest",              // 启动 MCP 服务器的命令
  "args": ["--config", "path/to/config.json"]   // 启动命令的参数，指向您的 config.json 配置文件路径
}

参数说明:

'name': MCP 服务器的名称，用于在客户端中标识和管理不同的 MCP 服务器连接。
'command': 启动 Obsidian MCP REST Server 的可执行命令。安装成功后，'obsidian-mcp-rest' 命令会被添加到系统路径中。
'args': 传递给 'obsidian-mcp-rest' 命令的参数。'--config path/to/config.json' 指定了服务器启动时读取的配置文件路径，请将 'path/to/config.json' 替换为您的 'config.json' 文件的实际路径。

基本使用方法

启动服务器: 在终端中，使用以下命令启动 Obsidian MCP REST Server，并指定您的 'config.json' 配置文件路径：
```
obsidian-mcp-rest --config path/to/config.json
```
服务器启动后，将通过标准输入/输出 (stdio) 监听 MCP 客户端的请求。
配置 MCP 客户端: 在您的 MCP 客户端（例如 Claude Desktop）中，按照客户端的指引添加新的 MCP 服务器配置，并填入上面提供的服务器配置 JSON。

通过 MCP 客户端与 Obsidian 交互: 配置完成后，您就可以在 MCP 客户端中使用预设的工具 (Tools) 与您的 Obsidian 知识库进行交互了。例如，您可以指示 AI 助手：

读取笔记 "Projects/MyProject.md"
列出 "Projects" 文件夹下的所有笔记
搜索包含 "typescript" 的笔记

AI 助手将通过 MCP 协议调用 Obsidian MCP REST Server 提供的工具，并将结果返回给您。

关键词