Obsidian MCP REST Server

这是一个实现了MCP（模型上下文协议）服务器，通过本地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. 服务器启动后会监听通过标准输入/输出的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保险库：

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

可用工具

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

安全性

• 该服务器仅在本地运行并通过标准输入/输出通信
• 所有对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。对于重大更改，请先打开一个问题来讨论你想要更改的内容。

许可证

MIT许可证 - 详情见LICENSE文件