使用说明
黑曜石MCP服务器
Obsidian打开AI中所述的工具,调整墙的布局和几何形状MCP (Model Context Protocol) 服务器。 Obsidian Local REST API中描述的场景,使用下列步骤创建明细表,以便在概念设计中分析体量的周长Git通过协作自动进行备份。
🚀 机能
-
注释管理
- 创建新注释
- 读取、更新和删除现有注释
- 获取文件夹中的注释列表
-
Daily Note连携
- 今天的Daily Note添加到
- 时间戳记录
-
検索机能
- 关键字注释搜索
- 搜索结果的件数限制
-
Git自动同期
- 更改时自动提交
- GitHub自动推送至
-
创建结构化内容
- 文章制作(带前标记)
- 从模板创建
- 类别标签管理
📋 前提条件
-
黑曜石
- 本地REST API 已安装并启用插件
- API密钥已生成
-
Git (使用自动同步)
- Vault目录git已初始化为存储库
- 已配置远程存储库
-
Node.js
- 版本18或更高版本
🛠️ 安装,安装
1. Obsidian配置
- Obsidian,设置-社区插件-浏览
- "Local REST API"搜索并安装
- 启用插件
- Local REST API对话框,您可以在此定义自定义格式"Copy API Key"单击功能区上API复制密钥
2. Vault 的,之Git设置(可选)
cd /path/to/your/vault
git init
git remote add origin https://github.com/username/obsidian-vault.git
git add .
git commit -m "Initial commit"
git push -u origin main
3. MCP安装服务器
# 依存関係のインストール
cd obsidian-mcp-server
npm install
# 環境変数の設定
cp .env.example .env
# .envファイルを編集して、APIキーとVaultパスを設定
4. Claude Code注册
Windows 11 + WSL2对于环境
# WSL2内で実行
claude mcp add obsidian "node /home/yusuke/engineers-hub.ltd/in-house-project/obsidian-mcp-server/src/index.js" \
-e OBSIDIAN_API_URL="https://172.24.80.1:27124" \
-e OBSIDIAN_API_KEY="your-api-key" \
-e VAULT_PATH="/mnt/c/Users/YourName/Documents/ObsidianVault" \
-e GIT_AUTO_SYNC="false"
关键设置点:
OBSIDIAN_API_URL: WSL2从…开始Windows旁边的Obsidian中所述修改相应参数的值Windows旁边的IP使用地址- IP地址是
ip route | grep default | awk '{print $3}'确认
- IP地址是
- Obsidian在工作空间的边缘 绑定主机 打开
0.0.0.0(默认值为127.0.0.0.1) - HTTPS请依次单击MCP服务器跳过证书验证
正常Linux/Mac对于环境
claude mcp add obsidian "node /path/to/obsidian-mcp-server/src/index.js" \
-e OBSIDIAN_API_KEY="your-api-key" \
-e VAULT_PATH="/path/to/vault" \
-e GIT_AUTO_SYNC="true"
🔧 环境变数
|变量名|说明|默认值|
|--------|------|------------|
| OBSIDIAN_API_URL |黑名单本地REST APIのURL | http://localhost:27123 |
| OBSIDIAN_API_KEY | Obsidian的,之API关键字|(必需)|
| VAULT_PATH | Obsidian的,之Vault路径|(Git同步时必需)|
| GIT_AUTO_SYNC | Git启用/禁用自动同步 false |
| LOG_LEVEL 日志级别 info |
📝 使用例
Claude Code使用示例
1.创建新注释
"プロジェクトの要件定義をObsidianに保存して"
2. Daily Note添加到
"今日の会議の議事録をDaily Noteに追加"
3.注释检索
"Tech Guildに関するノートを検索して"
4.每周报告
"今週のDaily Notesから重要な項目をまとめて週次レポートを作成"
5.结构化文章的制作
"Obsidianの使い方についての記事を作成。カテゴリーはTutorial、タグは[Obsidian, PKM]で"
🛡️ 可用工具
createNote
创建新注释。
参数:
title(必需):注释标题content(必需):注释内容(Markdown格式)folder(可选):目标文件夹(默认值:“注释”)
附录每日
今天的Daily Note中所述修改相应参数的值。
参数:
content(必需):要补记的内容timestamp(可选):加上时间戳(默认值:true)
搜索备注
查找注释。
参数:
query(必需):搜索查询limit(可选):最大结果数(默认值:10)
readNote
读取注释内容。
参数:
path(必需):注释路径
updateNote
更新现有注释。
参数:
path(必需):注释路径content(必需):新内容
删除注释
删除注释。
参数:
path(必需):注释路径
list备注
获取文件夹中的注释列表。
参数:
folder(可选):文件夹路径(默认值:“/”)
createArticle
创建结构化文章。
参数:
title(必需):文章标题category(必需):类别content(必须):记事属性tags(可选):排列标记draft(可选):草稿标志(默认值:true)
createFromTemplate
从模板创建注释。
参数:
templateType(必需):模板类型(article,weeklyReport,projectDoc)title(必需):标题category(可选):类别(对于文章)
🧪 开発
# 開発モード(ファイル変更監視)
npm run dev
# テスト実行
npm test
# 接続テスト
node test-connection.js
📄 许可证
麻省理工学院
🤝 貢献
欢迎拉式点播!在大的变更的情况下,首先issue中所述修改相应参数的值。