Obsidian MCP REST Server

基本能力

产品定位

Obsidian MCP REST Server 是一个连接 AI 助手和 Obsidian 知识库的中间件，提供标准化的接口让 AI 可以读取、写入和管理 Obsidian 笔记内容。

核心功能

• 通过 MCP 协议访问 Obsidian 知识库内容
• 读取和写入笔记
• 列出知识库内容
• 搜索功能
• 安全的本地 REST API 集成
• 兼容 Claude Desktop 和其他 AI 助手

适用场景

• AI 助手需要访问本地知识库内容
• 自动化管理 Obsidian 笔记
• 批量处理笔记内容
• 构建基于 Obsidian 的知识管理系统

工具列表

• listNotes: 列出知识库或特定文件夹中的所有笔记
• readNote: 读取特定笔记的内容
• writeNote: 创建或更新笔记
• searchNotes: 使用查询字符串搜索笔记
• getMetadata: 获取特定笔记的元数据

常见问题解答

安装问题

如果遇到安装问题，可以尝试以下替代方案：

1. 克隆并本地安装：

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

1. 如果看到 TypeScript 相关错误，确保全局安装了 TypeScript：

npm install -g typescript

使用教程

使用依赖

• Node.js 16 或更高版本
• 已安装并配置 Local REST API 插件的 Obsidian
• 已启用 Local REST API 的 Obsidian 知识库

安装教程

全局安装包：

npm install -g PublikPrinciple/obsidian-mcp-rest

或者使用特定版本/分支：

npm install -g PublikPrinciple/obsidian-mcp-rest#main

配置

1. 首先配置 Obsidian Local REST API 插件：
2. 在 Obsidian 中安装 Local REST API 插件
3. 配置 API 端口（默认：27123）

4. 生成并保存 API 密钥

5. 创建配置文件 config.json：

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

调试方式

1. 启动服务器：

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

1. 服务器将启动并通过 stdin/stdout 监听 MCP 请求。

与 Claude Desktop 一起使用

1. 配置 Claude Desktop 使用此 MCP 服务器：
2. 打开 Claude Desktop 设置
3. 导航到 MCP 部分

4. 添加新服务器配置： json { "name": "obsidian-mcp", "command": "obsidian-mcp-rest", "args": ["--config", "path/to/config.json"] }

5. Claude 现在可以通过以下命令访问您的 Obsidian 知识库： Read note "Projects/MyProject.md" List all notes in "Projects" folder Search for notes containing "typescript"

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。