基本能力
产品定位
Obsidian MCP 服务器旨在为AI模型提供与Obsidian知识库的无缝集成能力,使AI能够直接操作和管理笔记内容。
核心功能
- 与 Obsidian 知识库的无缝集成
- 支持笔记的读取、创建、更新和删除
- 支持文件夹的创建、重命名、移动和删除
- 支持全文搜索功能
- 符合 Model Context Protocol 规范
适用场景
- AI辅助笔记管理
- 自动化知识库维护
- 内容生成与更新
- 知识库搜索与检索
工具列表
list_notes
: 列出知识库中的所有笔记read_note
: 读取指定笔记的内容create_note
: 创建新笔记update_note
: 更新现有笔记search_vault
: 在知识库中搜索内容delete_note
: 删除笔记manage_folder
: 管理文件夹 (创建、重命名、移动、删除)
常见问题解答
- 确保 Obsidian 正在运行,并且已安装和配置了 Local REST API 插件
- 确保环境变量配置正确
- Docker 部署时需要确保容器能访问主机上的 Obsidian 实例和知识库
使用教程
使用依赖
- Node.js (v16 或更高版本)
- Obsidian 桌面应用
- Obsidian Local REST API 插件 (需要在 Obsidian 中安装)
安装教程
- 克隆此仓库:
bash
git clone https://github.com/newtype-01/obsidian-mcp.git
cd obsidian-mcp - 安装依赖:
bash
npm install - 构建项目:
bash
npm run build
配置
- 复制
.env.example
文件为.env
并编辑其中的值:
bash
cp .env.example .env - 编辑
.env
文件,填入您的实际配置:
OBSIDIAN_VAULT_PATH=/path/to/your/vault
OBSIDIAN_API_TOKEN=your_api_token_here
OBSIDIAN_API_PORT=27123
使用方法
- 确保 Obsidian 正在运行,并且已安装和配置了 Local REST API 插件
- 启动 MCP 服务器:
bash
npm start
调试方式
项目包含一个测试脚本,用于验证服务器功能:
bash
node test-mcp.js