Obsidian MCP Rest

🚀 Obsidian MCP REST 服务器

这是一个实现 Model Context Protocol (MCP) 的服务器，借助本地 REST API 实现对 Obsidian 笔记 vaults 的访问。该服务器为 AI 助手提供了标准化接口，使其能够与 Obsidian 笔记进行交互，并对 vault 内容进行管理。

🚀 快速开始

此服务器允许你通过本地 REST API 访问 Obsidian 笔记 vaults，为 AI 助手与笔记的交互提供便利。

✨ 主要特性

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

📦 安装指南

全局安装包

npm install -g PublikPrinciple/obsidian-mcp-rest

使用特定版本/分支

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

📚 详细文档

配置

配置 Obsidian Local REST API 插件

1. 在 Obsidian 中安装 Local REST API 插件。
2. 设置 API 端口（默认：27123）。
3. 生成并保存 API 密钥。

创建配置文件 config.json

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

使用方法

启动服务器

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

服务器启动后，将监听通过 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：

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

可用工具

• listNotes：列出 vault 中的所有笔记或特定文件夹的笔记
• readNote：读取特定笔记的内容
• writeNote：创建或更新笔记
• searchNotes：搜索符合指定条件的笔记
• getMetadata：获取笔记的元数据

安全注意事项

• 所有 API 请求都通过生成的 API 密钥进行身份验证。
• 服务器仅限本地网络访问，防止外部访问。
• 数据保留在本地设备，不会上传到任何服务器。

开发

克隆仓库

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

进入项目目录并安装依赖项

cd obsidian-mcp-rest
npm install

构建项目

npm run build

运行测试

npm test

故障排除

若安装失败，可尝试手动克隆仓库，并在其中运行安装和构建命令。同时，要确保 Node.js 和其他依赖项已正确安装。

贡献

欢迎提交 Pull Request！对于重大变更，请先在问题中讨论以获得反馈。

📄 许可证

此项目使用 MIT 许可证，详细信息请参阅 LICENSE 文件。