基本能力
产品定位
Obsidian MCP Server 是一个连接大型语言模型和 Obsidian 知识库的中间件，旨在通过标准化的接口实现 AI 与知识管理工具的高效交互。
核心功能
- 文件操作
- 原子性文件/目录操作与验证
- 资源监控和清理
-
错误处理和优雅失败
-
搜索系统
- 可配置上下文的全文本搜索
- 支持 JsonLogic 查询文件、标签和元数据
-
支持 glob 模式和 frontmatter 字段
-
属性管理
- YAML frontmatter 解析和智能合并
- 自动时间戳管理
-
自定义字段支持
-
安全与性能
- API 密钥认证与速率限制
- SSL 选项
- 资源监控和健康检查
适用场景
- AI 助手管理个人或团队知识库
- 自动化知识整理和分类
- 智能搜索和信息提取
- 批量修改文件属性和内容
工具列表
文件管理工具
obsidian_list_files_in_vault: 列出保险库内容obsidian_list_files_in_dir: 列出目录内容obsidian_get_file_contents: 获取文件内容
搜索工具
obsidian_find_in_file: 文本搜索obsidian_complex_search: 高级 JsonLogic 搜索obsidian_get_tags: 获取标签
内容修改工具
obsidian_append_content: 追加内容obsidian_patch_content: 更新内容
属性管理工具
obsidian_get_properties: 获取属性obsidian_update_properties: 更新属性
常见问题解答
- 需要先在 Obsidian 中启用 Local REST API 插件
- 自签名证书需要设置
VERIFY_SSL=false - 文件操作是原子性的，确保数据一致性
- 搜索功能支持复杂查询和上下文提取
使用教程
使用依赖
- 安装 Node.js
- 在 Obsidian 中启用 Local REST API 插件
安装教程
bash
git clone git@github.com:cyanheads/obsidian-mcp-server.git
cd obsidian-mcp-server
npm install
npm run build
或通过 npm 安装:
bash
npm install obsidian-mcp-server
配置
在 MCP 客户端设置中添加配置:
json
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": ["/path/to/obsidian-mcp-server/build/index.js"],
"env": {
"OBSIDIAN_API_KEY": "your_api_key_here",
"VERIFY_SSL": "false",
"OBSIDIAN_PROTOCOL": "https",
"OBSIDIAN_HOST": "127.0.0.1",
"OBSIDIAN_PORT": "27124"
}
}
}
}
调试方式
- 检查服务是否运行:
bash
ps aux | grep node - 测试 API 连接:
bash
curl -X GET "https://127.0.0.1:27124/api/health" -H "Authorization: Bearer your_api_key" - 查看日志:
bash
tail -f /var/log/obsidian-mcp-server.log
