Obsidian MCP REST Server

Obsidian MCP REST Server

用于通过本地REST API访问黑曜石的MCP服务器实现。

GitHub
Created ByPublikPrinciplePublikPrinciple

简介

Obsidian MCP REST 服务器允许 AI 助手(如 Claude)通过本地 REST API 访问和管理您的 Obsidian 笔记仓库。

前提条件

  • Node.js 16+
  • Obsidian 安装了本地 REST API 插件

快速设置

1. 安装

npm install -g PublikPrinciple/obsidian-mcp-rest

2. Obsidian 配置

  • 在 Obsidian 中安装并启用本地 REST API 插件
  • 设置 API 端口(默认:27123)
  • 生成 API 密钥

3. 创建配置文件

创建 config.json:

{
  "obsidian": {
    "apiKey": "your-api-key-here",
    "port": 27123,
    "host": "localhost"
  },
  "server": {
    "name": "obsidian-mcp",
    "version": "1.0.0"
  }
}

4. 启动服务器

obsidian-mcp-rest --config path/to/config.json

5. 与 Claude Desktop 集成

在 Claude Desktop 设置中添加新的 MCP 服务器配置:

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

主要功能

  • listNotes: 列出仓库笔记
  • readNote: 读取笔记内容
  • writeNote: 创建或更新笔记
  • searchNotes: 搜索笔记
  • getMetadata: 获取笔记元数据

使用示例

通过类似以下命令与 Claude 交互:

Read note "Projects/MyProject.md"
List all notes in "Projects" folder
Search for notes containing "typescript"

故障排除

如遇安装问题，尝试本地安装:

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git
cd obsidian-mcp-rest
npm install
npm run build
npm install -g .

安全说明

服务器仅本地运行，所有请求通过您的 API 密钥验证，数据保留在您的机器上。