mcp黑曜石cli
商标声明: “Obsidian”是Obsidian Publishing,股份有限公司的商标。本项目不隶属于或认可Obsidian出版社。
MCP服务器,包装了Obsidian CLI,使AI助手能够通过模型上下文协议完全访问Obsidian的原生API-搜索索引、wikilink解析、任务、属性、每日笔记、反向链接和80+命令。
为什么存在
每个现有的Obsidian MCP服务器都采用两种方法之一:本地REST API插件(需要API密钥、HTTP开销、有限的命令面)或原始文件系统访问(无Obsidian感知-无搜索索引、无wikilink解析、无任务查询)。两者都没有抓住重点。
mcp-obsidian-cli 封装了Obsidian CLI插件,该插件通过IPC直接与正在运行的Obsidian实例通信。这意味着可以完全访问Obsidian的内部API,无需任何配置-无API密钥,无REST插件,无令牌管理。
快速开始
npx mcp-obsidian-cliClaude桌面配置
添加 ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"obsidian": {
"command": "npx",
"args": ["-y", "mcp-obsidian-cli"],
"env": {
"OBSIDIAN_VAULT": "my-vault"
}
}
}
}需求
- 在CLI插件处于活动状态时运行黑曜石
obsidian在你的路上- Node.js>=18
运作原理
服务器将Obsidian CLI命令作为MCP工具公开。通用直通工具处理整个CLI界面(80多个命令),以及用于常见操作的键入便利工具:
| 工具 | 说明 |
|---|---|
obsidian | 通用直通--运行任何CLI命令 |
obsidian_daily_read | 阅读今天的每日简报 |
obsidian_daily_append | 添加到每日笔记中 |
obsidian_read | 按名称或路径阅读笔记 |
obsidian_search | 带上下文的全文搜索 |
obsidian_tags | 列出带有计数的标签 |
obsidian_tasks | 查询任务(每日、待办、已完成) |
obsidian_properties | 读取frontmatter属性 |
obsidian_create | 创建新笔记 |
obsidian_property_set | 设置frontmatter属性 |
obsidian_backlinks | 列出注释的反向链接 |
obsidian_files | 列出vault文件 |
obsidian_recents | 最近打开的文件 |
通用的 obsidian 工具意味着MCP服务器永远不会落后于CLI——新的CLI命令无需服务器更新即可立即工作。
环境变量
| 变量 | 默认值 | 描述 |
|---|---|---|
OBSIDIAN_VAULT | _(无)_ | 按名称列出目标保管库 |
OBSIDIAN_CLI_PATH | obsidian | CLI二进制文件的路径 |
OBSIDIAN_TIMEOUT_MS | 15000 | 命令超时 |
XDG_CONFIG_HOME | ~/.config | 配置文件的基本路径 |
配置文件
服务器可以从YAML配置文件中读取设置:
- 违约:
~/.config/mcp-obsidian-cli/config.yaml - 随着
XDG_CONFIG_HOME:$XDG_CONFIG_HOME/mcp-obsidian-cli/config.yaml
配置文件格式:
vault: "my-vault"
cliPath: "obsidian"
timeoutMs: 15000配置优先级:环境变量>配置文件>硬编码默认值
与替代品相比
| mcp-obsidian-cli | REST API服务器 | 文件系统服务器 | |
|---|---|---|---|
| 搜索索引 | 是 | 是 | 否 |
| 维基链接分辨率 | 是 | 部分 | 否 |
| 任务查询 | 是 | 否 | 否 |
| 属性类型 | 是 | 部分 | 否 |
| 每日笔记 | 是 | 否 | 否 |
| 反向链接 | 是 | 是 | 否 |
| API密钥 | 无 | 必需 | 无 |
| 黑名单插件 | CLI插件 | REST API插件 | 无 |
| 命令 | 80+ | ~10 | ~6 |
许可证
麻省理工学院

维护 @斯通马特 根据MIT许可证获得许可
