使用说明
黑曜石克劳德代码插件
一个MCP服务器,让AI助手直接访问文件系统 黑曜石 拱顶。内置Rust使用 rmcp.
Claude代码插件
使用黑曜石mcp最简单的方法是通过捆绑 Claude代码插件,它在MCP服务器上添加了即用型技能和代理。
包含什么
| 组件 | 它的作用 |
|---|---|
obsidian-writer 技能 |
创建或更新结构化黑曜石笔记——使用美人鱼图、深海笔记、维基链接和画布地图索引笔记 |
deep-researcher 技能 |
从网络上研究一个主题,并制作一份结构化的研究简报(关键概念、子主题、来源) |
obsidian-canvas 技能 |
构建或更新黑曜石画布,将笔记直观地映射为链接节点 |
obsidian-writer 代理 |
自主代理:给定一个主题,按照黑曜石写作技巧编写和维护金库笔记 |
research-and-save 代理 |
自主代理:从网络上研究一个主题,然后将结构化笔记+画布写入vault |
插件设置
步骤1--安装MCP服务器 (参见 安装 在......下面
步骤2——将插件安装到Claude代码中:
claude plugin add https://github.com/Mohd-Bilal/obsidian-mcp --subdir plugin
或者,如果你在本地克隆了仓库:
claude plugin add /path/to/obsidian-mcp/plugin
步骤3——验证:
claude plugin list
你应该看看 obsidian (v1.3.0)已列出。
使用技能
安装后,这些技能可以在任何Claude Code会话中使用:
# Write notes about a topic you already know
"create obsidian notes about the CAP theorem"
# Research a topic from the web and save to vault
"research how transformers work and save to obsidian"
# Update existing notes with new information
"add a section on RAFT consensus to my distributed systems notes"
这 research-and-save agent会自动触发以下短语:
- “研究X并保存”
- “查找X并添加黑曜石”
- “了解X并写笔记”
插件结构
plugin/
├── .claude-plugin/
│ └── plugin.json # Plugin manifest
├── skills/
│ ├── obsidian-writer/ # Note writing conventions
│ ├── obsidian-canvas/ # Canvas layout conventions
│ └── deep-researcher/ # Web research → structured brief
└── agents/
├── obsidian-writer.md # Vault writing agent
└── research-and-save.md # Research + write agent
MCP 服务器
特性
金库
vault_list--列出此计算机上注册的所有黑曜石保管库(名称、路径、打开状态、上次使用时间)vault_switch--切换当前会话的活动vault
备注
note_create--创建新注释(可选择从模板中创建)note_read--阅读笔记的原始降价内容note_update--覆盖笔记内容note_delete--删除注释
前言
frontmatter_read--将YAML frontmatter作为JSON对象读取frontmatter_write--合并或替换frontmatter字段
链接
link_insert_wikilink--插入a[[wikilink]](可选别名)添加到注释中link_get_backlinks--查找链接到给定笔记的所有笔记link_get_forward_links--在注释中列出所有维基链接
搜索
search_notes--在所有笔记中进行全文搜索,返回路径、行号和代码段
图像
image_embed--将现有vault附件嵌入到注释中image_import--将外部图像复制到vault中并嵌入
画布
canvas_read--阅读a.canvas文件(节点+边)canvas_create--创建新的画布文件canvas_update--覆盖画布的节点和边canvas_delete--删除画布文件
文件夹
folder_create--创建文件夹folder_rename--重命名或移动文件夹folder_delete--删除文件夹(force=true如果非空,则为必填项)
Git(背景)
- 启动时自动初始化vault中的git仓库(如果不存在)
- 可选的定期自动提交
GIT_AUTOCOMMIT_INTERVAL
安装
需要 锈 (稳定的工具链)。
git clone https://github.com/Mohd-Bilal/obsidian-mcp.git
cd obsidian-mcp/rust
cargo build --release
编译后的二进制文件位于 rust/target/release/obsidian-mcp.
配置
服务器会自动从以下位置发现您的保管库 ~/.config/obsidian/obsidian.json 在Linux或 ~/Library/Application Support/obsidian/obsidian.json 在macOS上(以最近打开的vault为准)。您可以用环境变量覆盖它。
| 环境变量 | 描述 | 默认值 |
|---|---|---|
OBSIDIAN_VAULT_PATH |
vault根目录的显式路径 | 自动发现 |
GIT_AUTOCOMMIT_INTERVAL |
自动提交间隔,例如。 15m, 1h, 300s |
残疾人 |
OBSIDIAN_TEMPLATES_FOLDER |
vault中模板的文件夹名称 | Templates |
克劳德桌面/Claude代码设置
添加 ~/.config/claude/claude_desktop_config.json 或 .mcp.json:
{
"mcpServers": {
"obsidian": {
"command": "/path/to/obsidian-mcp/rust/target/release/obsidian-mcp",
"env": {
"GIT_AUTOCOMMIT_INTERVAL": "15m"
}
}
}
}
发展
cd rust
# Build
cargo build
# Run tests
cargo test
# Run the server directly (stdio transport)
cargo run
许可证
麻省理工学院