iamzcr/dsh-obsidian-assistant 预览 preview

iamzcr/dsh-obsidian-assistant

DeepSeek Harness插件(Cordis工具集):操作本地Obsidian知识库(vault),提供搜索、读写笔记、双向链接/关系图谱、批量整理,并通过Obsidian的“Local REST API”社区插件调用高级能力(高速全文搜索、触发命令/模板)。

Project Overview项目介绍

This is a native DeepSeek Harness plugin built as a Cordis toolset bundle that enables DSH agents to interact with a local Obsidian vault. To install it, you need to add this repository to the dsh.profile.bundles array in your DSH profile's package.json file, then add a configuration entry to your profile's cordis.patch.yml to specify the absolute path of your local Obsidian vault. The plugin relies on the tools and fs services from the default DSH base bundle, so it must always be loaded after the base bundle in the bundle loading order.

The plugin works with two access channels for maximum flexibility. If you do not have Obsidian running, or do not have the Local REST API community plugin installed, it will automatically fall back to direct file system access, which supports all core read, write, search and organize operations. When Obsidian is running with Local REST API enabled, the plugin will use Obsidian's native indexed full-text search for faster results on large vaults, and also supports triggering custom Obsidian commands like Dataview re-renders. This makes it suitable for any DSH user that stores personal knowledge or writing drafts in Obsidian.

The plugin is released under the permissive MIT open source license, so you can modify it or use it in any personal or commercial project as long as you retain the original license terms. There are a few known limitations to note: move operations will leave an empty source file when using the DSH FileSystem backend, since DSH does not currently expose a delete or rename API for this backend. The Local REST API integration also does not have a native endpoint for Dataview queries, so you have to trigger Dataview commands via the run command tool instead.

这是一个专为 DeepSeek Harness 开发的原生 Cordis 插件,核心功能是让 DSH 智能体能够操作本地的 Obsidian 知识库(vault)。插件共提供 12 个工具,分为两个协作通道:不依赖 Obsidian 运行的文件直读写通道,可完成检索、读写、整理等基础操作;还有依赖 Obsidian Local REST API 社区插件的增强通道,支持高速全文搜索、触发自定义命令等高级能力。当 Obsidian 未运行时,会自动降级到全文件模式工作。

这款插件面向将笔记、知识素材甚至小说草稿存放在 Obsidian 中的 DSH 用户,可帮助智能体完成知识库内容检索、知识整理、笔记编辑等各类任务。比如用户让智能体基于个人知识库内容回答问题时,插件可以检索相关笔记为回答提供上下文;创作者也可以让智能体批量整理杂乱的笔记,或是将按章节存放的小说草稿导出为适合直接发布到各小说平台的格式。

该插件以 profile bundle 形式安装,用户需要将其添加到个人配置的 bundles 列表中,必填配置项仅为本地 Obsidian vault 的绝对路径,依赖 DSH base bundle 提供的文件系统和工具服务,必须挂载在 base bundle 之后。目前已知限制包括文件移动操作在部分后端会残留空文件,且暂无原生 Dataview 查询端点,代码开源遵循 MIT 许可证。

Pre-install check安装前体检Compatibility · Security兼容性 · 安全性 1 warning1 项注意
  • Only 5 stars - very few users, little community feedback星标只有 5,几乎没人在用,遇到问题缺少社区反馈
DSH walks through these 9 checksDSH 会逐条核对这 9 项

Compatibility兼容性

  • DSH, Node, OS and profile requirementsDSH 版本 / Node 版本 / 操作系统 / profile 是否满足要求
  • External dependencies and runtimes (Electron / Python / Docker, ...)外部依赖与运行时(Electron / Python / Docker 等)是否齐备
  • Conflicts with installed plugins: command names, skill / tool names, ports, duplicate MCP registration与已装插件是否冲突:命令名、skill / tool 重名、端口占用、重复 MCP 注册

Security安全性

  • Repo matches the facts registered here; archived or abandoned?仓库是否与页面登记一致,是否归档或长期停更
  • Safety of preinstall / install / postinstall and install.sh / setup.ps1preinstall / install / postinstall 与 install.sh、setup.ps1 是否安全
  • curl|bash, download-then-execute, obfuscation, unrelated domains → stop immediatelycurl|bash、下载即执行、混淆代码、无关域名 → 立刻停止
  • Typosquatting or unmaintained packages among the new dependencies新增依赖里有没有 typosquatting 或无人维护的包
  • Requested permissions vs. what the feature actually needs申请了哪些权限、是否超出功能所需(filesystem / network / shell / clipboard)
  • Any sudo / admin requirement, plus uninstall and rollback是否要求 sudo / 管理员权限,以及卸载与回滚方式

Anything uncertain must be marked unknown with a note on how to confirm it. This site's signal screen is a static snapshot, not a security audit.拿不准的必须标「未知」并说明要我怎么确认。本站的信号筛查是静态快照,不能替代安全审计。

Or use CLI install (for developers)或使用命令行安装(适合开发者)

CLI Install命令行安装

dsh plugin --profile web add github:iamzcr/dsh-obsidian-assistant

把 iamzcr/dsh-obsidian-assistant 加入你的 DSH 配置(web profile)即可启用。

READMEREADME

dsh-obsidian-assistant

DeepSeek Harness 插件(Cordis toolset):操作本地 Obsidian 知识库(vault),提供搜索、读写笔记、双向链接 / 关系图谱、批量整理,并通过 Obsidian 的 "Local REST API" 社区插件调用高级能力(高速全文搜索、触发命令 / 模板)。

一套插件,双通道,统一操作同一个 vault:不依赖 Obsidian 运行也能读写(文件通道),Obsidian 在线时自动增强(REST 通道)。


功能一览(12 个工具)

通道 A · 文件直读写(始终可用,不依赖 Obsidian 运行)

工具 说明
obsidian_search 全文 / 标题检索,支持按 tag 过滤,返回路径 + 片段 + 标签
obsidian_read_note 读单篇笔记(frontmatter + 正文),可带 / 不带 .md 后缀
obsidian_create_note 新建笔记(可带 YAML frontmatter,拒绝覆盖已存在笔记)
obsidian_update_note 字面量替换 / 追加编辑(幂等、安全)
obsidian_list_structure 文件夹树 + 标签统计 + 孤立笔记
obsidian_backlinks 反向链接 + 出链 + tag 归属图谱
obsidian_batch 批量移动 / 重命名,自动重写全库 [[wikilink]]
obsidian_export_novel 把 vault 里按 第X章-标题 命名的章节笔记,清洗成可粘贴到小说平台的 TXT / Markdown 文稿,按章号排序落盘

通道 B · Local REST API(需 Obsidian 运行 + 安装该社区插件)

工具 说明
obsidian_rest_search Obsidian 内部索引高速全文搜索(大库首选)
obsidian_list_commands 列出 Obsidian 命令(id + 名称)
obsidian_run_command 触发命令(Templater / Dataview 重渲染等)
obsidian_rest_query 透传任意 REST 端点(兜底 / 高级用法)

Dataview 说明:Local REST API 无原生 dataview 端点,dataview 查询需通过 obsidian_list_commands 找到 Dataview 命令 id,再用 obsidian_run_command 触发。


安装与注册

本插件是一个 profile bundle。完整、可操作的接入步骤见 DEPLOY.md。核心两步:

  1. 把 dsh-obsidian-assistant 加进 profile 的 bundles 列表($DSH_HOME/profiles/<name>/package.json 的 dsh.profile.bundles);
  2. 在 profile 的 cordis.patch.yml 里为它指定 vaultPath(唯一必填项,没有可移植的默认值,所以 bundle 里不预设):
# $DSH_HOME/profiles/<name>/cordis.patch.yml(顶层数组里追加)
- id: dsh-obsidian-assistant
  config:
    vaultPath: 'D:/my-notes'            # 必填:vault 根目录绝对路径(正斜杠)
    # 以下均为可选,有默认值:
    # apiUrl: 'https://127.0.0.1:27124'
    # apiToken: ''
    # enableRestApi: true
    # excludePatterns: ['.obsidian', '.trash']
    # maxResults: 50

本插件 inject: ["tools", "fs"],依赖 base bundle 提供的 tools 与 fs 服务,因此必须挂在 base bundle 之后(base 天然是第一个 bundle)。

配置项

字段 必填 默认 说明
vaultPath ✅ — vault 根目录绝对路径(正斜杠)
apiUrl https://127.0.0.1:27124 Local REST API 地址
apiToken "" Local REST API 的 API Key(每个 vault 独立)
enableRestApi true 是否启用通道 B(不可用自动降级)
excludePatterns ['.obsidian', '.trash'] 排除目录(前缀匹配或 * 通配)
maxResults 50 文件通道搜索最大命中数

Showing the opening section of the README — the full document lives in the repository以上为 README 开头摘要,完整文档在仓库内 · View the full README on GitHub →在 GitHub 查看完整 README →

← 上一个 Prev dsh-screenshot 下一个 Next dsh-notion →