Fnckerpoi/dsh-plugin-sirchmunk

dsh-plugin-sirchmunk

English

概述

dsh-plugin-sirchmunk 是一个 DSH 原生的 Web 插件，它在 DSH 设置界面中添加了一个 Sirchmunk 区块。该区块提供了一个统一的位置，用于检查知识图谱、管理集群、查看共享历史、监控运行时指标以及配置隐私控制。

当前 UI 使用位于 http://localhost:8584/api/v1/health 的本地 Sirchmunk 服务健康检查端点。图谱、集群、历史和指标数据由 src/services/api.ts 中的 API 适配器表示，可以在不更改 DSH 插件入口点的情况下连接到生产后端。

架构

该包遵循 DSH 主机/客户端分离模式：

cordis.patch.yml
└─ registers dsh-plugin-sirchmunk as the sirchmunk bundle entry

lib/index.js
└─ host entry: exports name and apply(ctx)

lib/client.js
└─ browser entry: window.__ModuleLoader__.load(...)
└─ apply(ctx)
└─ settings.section / sirchmunk / order 35
└─ src/App.tsx
├─ graph view
├─ cluster manager
├─ shared history
├─ runtime metrics
└─ privacy and permission settings

React 和 ReactDOM 是由 DSH 运行时提供的对等依赖项。浏览器构建将这两个包视为外部依赖项，因此它们不会嵌入到发布的客户端包中。

功能

- 知识图谱： 显示图谱节点，并将当前图谱导出为 JSON。
- 集群管理： 列出集群，并通过显式的写入权限开关和确认步骤来保护破坏性操作。
- 运行时监控： 显示由 Sirchmunk API 适配器暴露的 CPU、内存和运行时间指标。
- 共享历史： 呈现带时间戳的审计和活动事件。
- 隐私与掩码： 启用敏感数据掩码、可配置的掩码关键词以及全局写入权限控制。
- DSH 原生设置集成： 通过 settings.section 槽注册该区块，ID 为 sirchmunk，顺序为 35。
- 捆绑的 Agent Skill（sirchmunk-search）： 提供一个标准化技能，允许用户和代理使用 Sirchmunk MCP 搜索工具（mcp__sirchmunk__sirchmunk_search）主动查询本地知识和文档，支持 100 多种文件格式（PDF、DOCX、XLSX、Markdown、代码等）。支持 FAST、DEEP 和 FILENAME_ONLY 模式。

在 DSH 中安装

已发布的包

在 DSH 主机所使用的同一 Node.js 包环境中安装该包：

npm install dsh-plugin-sirchmunk
包元数据将 DSH 指向 cordis.patch.yml，宿主入口为 lib/index.js，Web 客户端入口为 lib/client.js。安装后重启 DSH 宿主，以便其应用 bundle 补丁并加载浏览器模块。随后设置界面将在 settings.section 插槽中显示 Sirchmunk。

本地包

构建项目并将其目录安装到 DSH 包环境中：

cd /path/to/dsh-plugin-sirchmunk
npm install
npm run build

cd /path/to/your/dsh-package-environment
npm install /path/to/dsh-plugin-sirchmunk

替换或升级本地构建后，请重启 DSH。

本地开发

要求：

- Node.js 18 或更高版本
- npm
- 用于端到端插件加载的 DSH 宿主
- 可选的 Sirchmunk 后端，位于 http://localhost:8584

安装依赖并启动 Vite 开发服务器：

npm install
npm run dev

运行静态类型检查并创建 DSH 包入口：

npm run typecheck
npm run build

构建产物包括：

- lib/index.js：ESM 宿主入口。
- lib/client.js：由 window.__ModuleLoader__.load 包装的 CommonJS 客户端 bundle。

发布前创建并检查确切的 npm 发布归档：

npm pack --dry-run

npm publish 会运行 prepack 脚本，该脚本会在 npm 创建归档之前重新构建两个入口。

中文

项目简介

dsh-plugin-sirchmunk 是一个 DSH 原生 Web 插件，用于在 DSH 设置界面中注册 Sirchmunk 设置区域。该页面集中提供知识图谱、聚类管理、共享历史、运行监控以及隐私与权限设置。

当前 UI 会通过 http://localhost:8584/api/v1/health 检查本地 Sirchmunk 服务状态。图谱、聚类、历史和监控数据通过 src/services/api.ts 中的 API 适配层访问，后续可在不改动 DSH 插件入口的前提下接入生产后端。

架构设计

该包按照 DSH 的 Host/Client 双入口模式组织：

cordis.patch.yml
└─ 将 dsh-plugin-sirchmunk 注册为 sirchmunk bundle 入口

lib/index.js
└─ Host 入口：导出 name 和 apply(ctx)

lib/client.js
└─ Browser 入口：window.__ModuleLoader__.load(...)
└─ apply(ctx)
└─ settings.section / sirchmunk / order 35
└─ src/App.tsx
├─ 图谱视图
├─ 聚类管理
├─ 共享历史
├─ 运行监控
└─ 隐私和权限设置

React 和 ReactDOM 由 DSH 运行时提供，并作为 peer dependency 声明。Browser 构建会将它们外置，不将 React 运行时打入发布包。

功能特性

- 知识图谱： 展示图谱节点，并可将当前图谱导出为 JSON。
- 聚类管理： 展示聚类列表，对删除等操作增加全局写权限和二次确认。
- 运行监控： 展示 Sirchmunk API 适配层返回的 CPU、内存和运行时长指标。
- 共享历史： 展示带时间戳的审计与活动记录。
- 隐私与脱敏： 提供敏感信息脱敏开关、可配置关键词和全局写操作权限。
- DSH 原生设置集成： 通过 settings.section slot 注册，ID 为 sirchmunk，顺序为 35。
- 内置 Agent Skill (sirchmunk-search)： 提供内置的技能规范，支持使用者或 Agent 主动调用 Sirchmunk MCP 检索工具（mcp__sirchmunk__sirchmunk_search）对本地文档与知识库进行跨格式（PDF、Word、Excel、PPTX、Markdown、代码等 100+ 种格式）查询，支持 FAST 快速匹配、DEEP 深度大模型综合分析与 FILENAME_ONLY 仅文件名匹配模式。

在 DSH 中安装

安装已发布包

在 DSH Host 使用的 Node.js 包环境中安装：

npm install dsh-plugin-sirchmunk
包元数据会将 DSH 指向 cordis.patch.yml、Host 入口 lib/index.js 和 Web Client 入口 lib/client.js。安装后重启 DSH Host，使其应用 bundle patch 并加载浏览器模块。加载成功后，设置界面的 settings.section 会出现 Sirchmunk。

安装本地包

先构建项目，再将项目目录安装到 DSH 的包环境：

cd /path/to/dsh-plugin-sirchmunk
npm install
npm run build

cd /path/to/your/dsh-package-environment
npm install /path/to/dsh-plugin-sirchmunk

替换或升级本地构建后需要重启 DSH。

本地开发指南

环境要求：

- Node.js 18 或更高版本
- npm
- 用于端到端加载验证的 DSH Host
- 可选：运行在 http://localhost:8584 的 Sirchmunk 后端

安装依赖并启动 Vite 开发服务：

npm install
npm run dev

运行静态类型检查并生成 DSH 发布入口：

npm run typecheck
npm run build

构建产物：

- lib/index.js：ESM Host 入口。
- lib/client.js：由 window.__ModuleLoader__.load 包裹的 CommonJS Client bundle。

发布前生成并检查 npm 实际打包清单：

npm pack --dry-run

npm publish 会自动执行 prepack，在 npm 生成发布包之前重建两个入口。