Obsidian MCP REST Server

Obsidian MCP REST 服务

这是一个 MCP（Model Context Protocol）服务实现，可通过本地 REST API 访问 Obsidian 知识库。此服务允许 AI 助手通过标准化接口与 Obsidian 笔记交互并管理知识库内容。

功能

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

前提条件

• 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 插件：

   • 在 Obsidian 中安装 Local REST API 插件
   • 配置 API 端口（默认值：27123）
   • 生成并保存 API 密钥

2. 创建配置文件 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

2. 服务将启动，并通过 stdin/stdout 侦听 MCP 请求。

与 Claude Desktop 配合使用

1. 配置 Claude Desktop 以使用此 MCP 服务：

   • 打开 Claude Desktop 设置
   • 导航至 MCP 部分
   • 添加新的服务配置：

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

2. 现在，Claude 可以通过以下命令访问你的 Obsidian 知识库：

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

可用工具

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

安全

• 服务仅在本地运行，并通过 stdin/stdout 通信
• 所有对 Obsidian REST API 的请求均使用你的 API 密钥进行身份验证
• 无需访问外部网络
• 数据保留在本机

开发

1. 克隆仓库：

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git
cd obsidian-mcp-rest

2. 安装依赖：

npm install

3. 构建项目：

npm run build

4. 运行测试：

npm test

故障排除

安装问题

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

1. 克隆并在本地安装：

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

2. 如果看到与 TypeScript 相关的错误，请确保已全局安装 TypeScript：

npm install -g typescript

贡献

欢迎贡献！请随时提交 Pull Request。对于重大更改，请先创建 issue，讨论你想要进行的更改。

许可证

MIT 许可证——详情请参阅 LICENSE 文件