dsh-plugin-rag
模型与 MCP 活跃维护

dsh-plugin-rag

mervyn-teo/dsh-plugin-rag

一款RAG语义记忆插件,可自动为所有历史聊天会话构建语义索引,自包含运行无需额外依赖,能基于过往对话精准检索相关信息,全程非破坏性操作不修改原始会话数据。

0
Stars 标星
0
Forks 分支
0
Watchers 关注
0
Open Issues
JavaScript
主要语言
MIT
开源协议
847 KB
仓库大小
1 个月前
最后推送
一键安装扩展 / 插件指令
dsh plugin --profile web add github:mervyn-teo/dsh-plugin-rag
git clone https://github.com/mervyn-teo/dsh-plugin-rag.git
git clone git@github.com:mervyn-teo/dsh-plugin-rag.git
README.md master

dsh-plugin-rag

dsh-plugin-rag — semantic memory for your DSH sessions

Semantic memory (RAG) over all your DeepSeek Harness chat sessions — automatic, self-contained, and non-destructive.

Install · How it works · Settings · The rag_search tool · Uninstall


What it does

dsh-plugin-rag turns every conversation you have with the harness into a
searchable memory. As you chat, the plugin increments the index with each
new message and decrements it when compaction/pruning shadows old content,
so retrieval always reflects the current surface of your sessions — never a
stale dump.

  • Automatic — no rebuild schedule, no manual export. It listens to the
    session store and stays in sync as you work.
  • Self-contained — embeddings come from any OpenAI-compatible
    /embeddings endpoint; vectors live in one local JSON file. No native
    modules, no database, no extra service.
  • Non-destructive — it listens to published session events. It never
    patches the agent loop, and uninstalling restores the harness to its exact
    original state.
  • Model-agnostic — choose a built-in preset or plug in your own
    endpoint, model, and API key.

dsh-plugin-rag demo

Install

A DSH plugin is a plain npm/Cordis package. Install it exactly like the
terminal or
qr-connect plugins: add
it to your profile's dependencies, bundle list, and one cordis.patch.yml
insert row.

  1. Add the package to your profile's package.json (e.g. ~/.dsh/profiles/web/package.json):

    {
     "dependencies": {
       "dsh-plugin-rag": "github:mervyn-teo/dsh-plugin-rag"
     },
     "dsh": {
       "profile": {
         "bundles": [
           "@deepseek-ai/dsh-base",
           "@deepseek-ai/dsh-web-app",
           "dsh-plugin-rag"
         ]
       }
     }
    }

    Or install from a local clone: "dsh-plugin-rag": "file:/path/to/dsh-plugin-rag".

  2. Add the insert row to your profile's cordis.patch.yml (create it if it
    doesn't exist):

    - insert:
       - id: rag
         name: dsh-plugin-rag
         config:
           enabled: true
           provider: soclaas-bge-m3
           model: bge-m3
           endpoint: https://soclaas-api.comp.nus.edu.sg/v1
           apiKey: ""
           apiKeyEnv: SOCLAAS_API_KEY
           topK: 5
           dataDir: ""
           includeToolResults: true
           includeReasoning: false
           maxChunkChars: 4000
  3. Reinstall and restart the harness so the profile re-resolves its
    dependencies and mounts the new bundle.

Settings

Open Settings → Plugins → RAG Memory. The card exposes exactly the fields
you need to point the indexer at any embeddings provider:

Field Purpose
Enable indexing Toggle the indexer and the rag_search tool.
Embedding model Pick an existing presetBGE-M3 (SoCLaaS), OpenAI text-embedding-3-small/large, or Ollama nomic-embed-text — or Custom… to supply your own.
Endpoint URL Base URL of any OpenAI-compatible embeddings endpoint.
Model name The model string sent to the endpoint.
API key Paste a key directly, or leave empty to read it from an environment variable.
Key env var The environment variable read when the API key field is empty.
Results Default number of hits returned by rag_search.
Index tool results Also index tool output (on by default).
Index reasoning Also index model reasoning blocks (off: noise + privacy).
Max chars per chunk Chunk size for long messages.

The card also shows a live index status (chunk count, session count, vector
dimension, model, data dir) and a Reindex button.

⚠️ Changing the model or endpoint triggers a full rebuild, because
embedding vectors are not comparable across models or providers.

The rag_search tool

Once installed, the model gains a first-class rag_search tool. It embeds the
query with your configured endpoint and returns the most relevant past
messages — each with role, session title, and snippet — so the agent can recall
prior work, decisions, code, and context across sessions.

rag_search("how did we set up the terminal plugin's WebSocket handshake?")

How it works

The plugin plugs into the harness the non-destructive way — by subscribing
to events the session store already publishes:

Event Effect
session/created Replays the (new or resumed) session's log from the stored cursor forward.
session/event Increment/decrement — indexes new user/message, assistant/message, and tool/result surface events; un-indexes entries shadowed by a replace (compaction / tool-result pruning).
session/flush Awaited durability checkpoint; drains the pending embed batch.

Message extraction is deliberate about noise:

  • only human user/message events (real prompts, not system-prompt or
    runtime-context injections) are indexed;
  • assistant/message contributes its final text blocks (not reasoning or
    tool-call blocks — those are skipped unless you enable Index reasoning);
  • tool/result contributes tool output (optional, and truncated by the
    chunker).

Embeddings are written to ~/.dsh/rag/index.json (configurable via dataDir)
using an atomic tmp+rename write. A per-session cursor tracks the last
processed seq, so restarts are idempotent and only new content is embedded.

Uninstall

Uninstall is just as clean as install — nothing in the harness was modified:

  1. Remove the dsh-plugin-rag entry from cordis.patch.yml and from
    dsh.profile.bundles.
  2. Remove it from package.json dependencies.
  3. Reinstall and restart.

Cordis disposes the plugin's scope (listeners, the rag_search tool, and the
config route) automatically, leaving the harness byte-identical to before. The
only residue is the index file itself; delete ~/.dsh/rag/ (or your dataDir)
to purge the stored vectors.

Configuration reference

Key Default Contract
enabled true Whether indexing and the rag_search tool are active.
provider soclaas-bge-m3 soclaas-bge-m3 · openai-3-small · openai-3-large · ollama-nomic · custom
model bge-m3 Model string sent to the endpoint (overrides the preset's model).
endpoint https://soclaas-api.comp.nus.edu.sg/v1 OpenAI-compatible embeddings base URL.
apiKey "" API key; empty reads apiKeyEnv.
apiKeyEnv SOCLAAS_API_KEY Environment variable for the key.
topK 5 Default result count (1–50).
dataDir "" Index directory; empty means ~/.dsh/rag.
includeToolResults true Index tool results.
includeReasoning false Index reasoning blocks.
maxChunkChars 4000 Max characters per chunk (256–16000).

Privacy

Everything stays on your machine by default: the index is a local file, and the
only outbound traffic is the embedding request to the endpoint you configure.
API keys are never written into the index; they are read from the environment
or kept in the plugin's runtime config.

License

MIT