Obsidian MCP REST 服务器

一个 MCP (模型上下文协议) 服务器实现，通过本地 REST API 提供对 Obsidian vault 的访问。此服务器允许 AI 助手通过标准化接口与 Obsidian 笔记交互并管理 vault 内容。

功能

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

前提条件

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

安装

全局安装包：

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 vault：

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

可用工具

• listNotes: 列出 vault 或特定文件夹中的所有笔记
• 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 文件