使用说明
黑曜石cli-mcp
用于从Claude Desktop/Claude Code操作Obsidian的MCP服务器。
提供两个后端:
- 服务器.py (CLI版) — Obsidian 1.12+ の公式 CLI 経由
- fs_server.py (FS版)—直接操作Vault文件系统(不需要CLI)
前提条件
CLI版 (server.py)
- 已安装并启动Obsidian1.12+
- CLI が有効 (Settings → General → Command line interface)
- 在权益访问期间
- Python 3.10+,
uv
FS版 (fs_server.py)
OBSIDIAN_VAULT_PATH仅设置环境变量- Python 3.10+,
uv
安装,安装
# リポジトリから直接インストール
pip install git+https://github.com/toocheap/obsidian-cli-mcp.git
# または uv を使用
uv tool install git+https://github.com/toocheap/obsidian-cli-mcp.git
开发设置
cd ~/src/obsidian-cli-mcp
uv sync
在Claude Desktop中使用
~/Library/Application Support/Claude/claude_desktop_config.json 添加到:
仅限CLI版
{
"mcpServers": {
"obsidian": {
"command": "uv",
"args": ["run", "--directory", "~/src/obsidian-cli-mcp", "server.py"]
}
}
}
仅限FS版
{
"mcpServers": {
"obsidian_fs": {
"command": "uv",
"args": ["run", "--directory", "~/src/obsidian-cli-mcp", "fs_server.py"],
"env": {
"OBSIDIAN_VAULT_PATH": "/Users/too/Obsidian/too"
}
}
}
}
两者同时(不冲突,因为工具名称前缀不同)
{
"mcpServers": {
"obsidian": {
"command": "uv",
"args": ["run", "--directory", "~/src/obsidian-cli-mcp", "server.py"]
},
"obsidian_fs": {
"command": "uv",
"args": ["run", "--directory", "~/src/obsidian-cli-mcp", "fs_server.py"],
"env": {
"OBSIDIAN_VAULT_PATH": "/Users/too/Obsidian/too"
}
}
}
}
已重新启动Claude Desktop。
在Claude Code中使用
# CLI版
claude mcp add obsidian -- uvx --from git+https://github.com/toocheap/obsidian-cli-mcp.git obsidian-mcp
# FS版
claude mcp add obsidian_fs -e OBSIDIAN_VAULT_PATH=/Users/too/Obsidian/too -- uvx --from git+https://github.com/toocheap/obsidian-cli-mcp.git obsidian-fs-mcp
CLI版工具一览
工具|CLI命令|说明|
|--------|-------------|------|
| obsidian_daily_read | daily:read 阅读每日笔记
| obsidian_daily_append | daily:append 在每日笔记本上追记
| obsidian_tasks_list | tasks 任务列表(支持筛选器)
| obsidian_task_toggle | task ref=... toggle 任务完成/未完成切换
| obsidian_search | search 在Vault中查找文本
| obsidian_tags_list | tags all counts 标签列表(带计数)
| obsidian_tag_info | tag name=... 特定标签详细信息
| obsidian_vault_info | vault | Vault情报|
FS版工具一览
工具|说明|
|--------|------|
| obsidian_fs_search |文件名·内容检索|
| obsidian_fs_read |注释读取(带元数据)|
| obsidian_fs_create 制作注释
| obsidian_fs_edit |注释编辑(append/prepend/replace)|
| obsidian_fs_delete 删除注释
| obsidian_fs_list_folder 查看文件夹结构
| obsidian_fs_get_tags 全标签一览表(带计数)
| obsidian_fs_get_backlinks |反向链接解析|
| obsidian_fs_daily_note 创建每日注释
扩张
CLAUDE.md 来修改标记元素的显示属性。CLI命令列表:https://help.obsidian.md/cli