staff-os/dsh-ragflow

Plugin插件 Native原生 ⭐ 2 Memory & Knowledge记忆与知识库

DeepSeek Harness 的 RAGFlow 知识库检索插件。

Project Overview项目介绍

This is a plugin built exclusively for DeepSeek Harness (DSH) that adds RAGFlow knowledge base retrieval capability to DSH agents. It ships with a native DSH bundle manifest and can be installed directly using the DSH CLI with the command dsh plugin --profile web add "github:staff-os/dsh-ragflow#main". Once installed, it exposes a ragflow_retrieve tool that queries configured RAGFlow datasets and returns relevant document chunks with similarity scores and source attribution. Since the compiled lib/ directory is committed to the repository, no build step is required at install time. After installation, users just need to restart the DSH web process to activate the plugin.

The plugin follows DSH's three-role capability pattern, splitting into four plugin entry points: service definition, service provider, model-facing tool, and user-facing configuration page. Each entry point can be overridden, replaced, or removed individually without modifying other parts, making it easy to customize for specific use cases. Before the tool can be used, users need to have a running RAGFlow instance (either self-hosted or cloud), a valid RAGFlow API key, and at least one dataset with parsed documents configured. Users can choose from three configuration methods: web configuration page, environment variables, or YAML config.

Configuration can be done via three methods, and the API key is stored securely through DSH's credential service so it never appears as plaintext in configuration files. Currently, the plugin only supports retrieval functionality, and does not include dataset or document management features like creating, uploading, or parsing documents. Several advanced RAGFlow retrieval options are also not yet exposed, including cross-language search, metadata filtering, and knowledge graph integration. The plugin does not support streaming responses, and results are rendered as a generic search card rather than a custom citation card.

这是一个专为 DeepSeek Harness 开发的原生插件,用于对接 RAGFlow 知识库的检索能力。它会为 DSH 代理提供一个 ragflow_retrieve 工具,能够查询用户配置的 RAGFlow 数据集,返回匹配的文档片段,同时附带相似度评分和来源信息。插件遵循 DSH 原生插件规范打包,自带 bundle 清单,可以直接通过 DSH 命令行工具一键安装。

插件遵循 DSH 三角色能力模式设计,拆分为服务定义、服务提供者、工具消费者和配置页面四个入口,支持单独覆盖、替换或移除任意模块,方便自定义改造。用户完成安装后,需要先配置 RAGFlow 的实例地址、API 密钥以及至少一个已完成文档解析的数据集,才能正常使用检索功能。

配置可以通过 Web 配置页面、环境变量或 YAML 三种方式完成,API 密钥会通过 DSH 凭据服务存储,不会明文保存在配置文件中。目前插件仅支持检索功能,不提供数据集和文档管理能力,部分 RAGFlow 高级检索选项暂未开放,源码已提交编译产物,安装时无需重新构建。

Pre-install check安装前体检Compatibility · Security兼容性 · 安全性 2 warnings2 项注意
  • No license declared - all rights reserved by default; ask the author before commercial use or redistribution未声明开源许可证 —— 默认「保留所有权利」,商用或再分发前先问作者
  • Only 2 stars - very few users, little community feedback星标只有 2,几乎没人在用,遇到问题缺少社区反馈
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:staff-os/dsh-ragflow#main"

把 staff-os/dsh-ragflow 加入你的 DSH 配置(web profile)即可启用。

READMEREADME

dsh-ragflow

English | 中文

RAGFlow knowledge-base retrieval for the DeepSeek Harness. It gives the agent a ragflow_retrieve tool that queries your RAGFlow datasets and returns document chunks with similarity scores and source names.

Design

The package follows the Harness three-role capability pattern: one seam, one provider, one consumer — shipped as one package with four plugin entry points (the fourth is the configuration page over the same values), so a profile can override, replace, or drop any single role without touching the others.

Role Module Plugin name Responsibility
Service Definition src/index.ts @deepseek-ai/dsh-ragflow Owns ctx.ragflow: provider registry, order-independent selection, maxChunks enforcement
Service Provider src/http.ts @deepseek-ai/dsh-ragflow/http Calls POST /api/v1/retrieval, resolves credentials, normalizes chunks
Consumer src/tool.ts @deepseek-ai/dsh-ragflow/tool The model-facing tool: schema, prompt guidance, chunk bound, presentation
Consumer src/config.ts @deepseek-ai/dsh-ragflow/config The person-facing configuration page over the same settings and credential seams

The provider and the consumer depend only on the Service Definition, never on each other. Replacing the backend means replacing one row:

- id: ragflow-http
  name: 'your-own-ragflow-provider'

Prerequisites

  1. A running RAGFlow instance — self-hosted or cloud. Defaults to http://localhost:9380.
  2. An API key — create one in RAGFlow.
  3. A dataset with parsed documents — RAGFlow rejects a retrieval that names no dataset and no document, so at least one dataset id must be configured.

Install

dsh plugin --profile web add "github:staff-os/dsh-ragflow#main"

dsh plugin add forwards the source to pnpm as-is, so any pnpm-recognized source works:

dsh plugin --profile web add link:/path/to/dsh-ragflow   # local development

lib/ is committed, so no build script runs at install time and pnpm needs no build allowance. Restart dsh web afterwards, then verify the four rows landed:

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-plugin-thinking-api 下一个 Next dsh-sketchup →