使用说明

项目简介

Obsidian MCP REST Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，它允许 AI 助手（如 Claude Desktop）通过标准化的 MCP 协议与本地 Obsidian 知识库进行交互。该服务器通过 Obsidian Local REST API 插件桥接，将 Obsidian 的笔记内容和管理功能暴露给 AI 助手，从而扩展 AI 的上下文理解和知识获取能力。

主要功能点

访问 Obsidian 笔记内容: AI 助手可以读取 Obsidian 笔记的内容。
编辑 Obsidian 笔记: AI 助手可以创建、更新 Obsidian 笔记。
列出知识库内容: AI 助手可以获取 Obsidian 知识库中的笔记列表，并支持按文件夹筛选。
搜索笔记: AI 助手可以根据关键词在 Obsidian 知识库中搜索笔记。
获取笔记元数据: AI 助手可以获取 Obsidian 笔记的元数据信息。
本地安全访问: 服务器以本地 REST API 方式运行，数据安全可靠。

安装步骤

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

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

npm install -g PublikPrinciple/obsidian-mcp-rest

服务器配置

要将此 MCP 服务器配置到 MCP 客户端（例如 Claude Desktop），您需要提供服务器的启动命令和参数。以下是一个配置示例，您需要根据实际情况修改 'command' 和 'args' 字段。

{
  "name": "obsidian-mcp",
  "command": "obsidian-mcp-rest",
  "args": ["--config", "/path/to/config.json"]
}

参数说明:

'name': MCP 服务器的名称，可以自定义。
'command': 启动 MCP 服务器的命令，这里是 'obsidian-mcp-rest'（安装后添加到全局环境）。
'args': 传递给启动命令的参数，这里使用 '--config' 参数指定配置文件 'config.json' 的路径。请将 '/path/to/config.json' 替换为您实际的 'config.json' 文件路径。

'config.json' 配置文件示例:

您需要在服务器启动前创建 'config.json' 配置文件，用于配置 Obsidian 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 服务器名称，与客户端配置中的 name 保持一致
    "version": "1.0.0"              // MCP 服务器版本
  }
}

基本使用方法

启动 Obsidian MCP REST Server: 在终端中使用以下命令启动服务器，并指定 'config.json' 文件的路径：
```
obsidian-mcp-rest --config /path/to/config.json
```
请将 '/path/to/config.json' 替换为您实际的 'config.json' 文件路径。
配置 MCP 客户端: 在您的 MCP 客户端（如 Claude Desktop）中，按照其 MCP 服务器配置指引，添加上述提供的 JSON 配置信息。
通过 AI 助手访问 Obsidian: 配置完成后，您就可以在 AI 助手中使用指令来访问和操作您的 Obsidian 知识库，例如：
- 'Read note "Projects/MyProject.md"' (读取笔记)
- 'List all notes in "Projects" folder' (列出文件夹下的所有笔记)
- 'Search for notes containing "typescript"' (搜索包含关键词 "typescript" 的笔记)

关键词