AI导哈

Obsidian CLI MCP服务

一个封装Obsidian CLI和同步客户端的MCP服务器，允许AI工具与Obsidian知识库交互。

  • by arvenkatachalam
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 arvenkatachalam/obsidian-cli-mcp

使用说明

黑曜石cli-mcp

包装Obsidian CLI的MCP服务器(obsidian)无头同步客户端(ob)因此，任何与MCP兼容的AI工具都可以与黑曜石金库进行交互。

需要 黑曜石1.12+ 介绍了CLI工具。

安装

git clone <repo-url> && cd obsidian-cli-mcp
npm install && npm run build

配置

添加到MCP客户端配置中（例如Claude Code ~/.mcp.json):

{
  "mcpServers": {
    "obsidian": {
      "command": "node",
      "args": ["/path/to/obsidian-cli-mcp/dist/index.js"],
      "env": {
        "OBSIDIAN_VAULT": "My Vault Name",
        "OBSIDIAN_VAULT_PATH": "/path/to/My Vault Name"
      }
    }
  }
}

环境变量

变量 默认值 描述
OBSIDIAN_VAULT （无） 默认保管库名称（由使用 obsidian CLI）
OBSIDIAN_VAULT_PATH （无） Vault文件系统路径（由使用 ob 同步命令）
OBSIDIAN_CLI_PATH obsidian 通往 obsidian 二进制
OB_CLI_PATH ob 通往 ob 二进制
OBSIDIAN_CLI_TIMEOUT 30000 CLI超时（毫秒）
OB_CLI_TIMEOUT 60000 同步超时（ms）

工具（18）

阅读

  • obsidian_read --阅读笔记内容
  • obsidian_search --带上下文的全文搜索
  • obsidian_outline --标题结构
  • obsidian_backlinks --传入链接
  • obsidian_links --传出链接
  • obsidian_tags --带有计数的标签
  • obsidian_tasks --待办/已完成任务

写作

  • obsidian_create --创建笔记
  • obsidian_append --附注
  • obsidian_prepend --注意事项
  • obsidian_property_set --设置frontmatter属性
  • obsidian_task_update --切换/完成任务

导航

  • obsidian_files --列出文件
  • obsidian_folders --列出文件夹
  • obsidian_templates --列出模板
  • obsidian_vault_info --Vault元数据

同步

  • obsidian_sync --触发器同步
  • obsidian_sync_status --检查同步状态

发展

npm test              # run all tests
npm run test:security # security tests only
npm run build         # compile TypeScript

许可证

麻省理工学院

相关 MCP