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库

安装

全局安装包：

bash
npm install -g PublikPrinciple/obsidian-mcp-rest

或者，如果您更喜欢使用特定版本/分支：

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

配置

1. 首先，配置Obsidian Local REST API插件：

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

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

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

使用

1. 启动服务器：
   bash
   obsidian-mcp-rest --config path/to/config.json

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

与Claude Desktop一起使用

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

   • 打开Claude Desktop设置
   • 导航到MCP部分
   • 添加新的服务器配置：
     json
     {
     "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. 克隆仓库：
   bash
   git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git
   cd obsidian-mcp-rest

2. 安装依赖项：
   bash
   npm install

3. 构建项目：
   bash
   npm run build

4. 运行测试：
   bash
   npm test

故障排除

安装问题

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

1. 克隆并在本地安装：
   bash
   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：
   bash
   npm install -g typescript

贡献

欢迎贡献！请随时提交Pull Request。对于重大更改，请先打开一个问题讨论您想要更改的内容。

许可证

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