dsh-brain/README.md

83 lines
4.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
# 🧠 dsh-brain
**把 DeepSeek Harness 接到你自己的 LongMemory 云端记忆服务。**
每轮对话自动上报活动 · 让 agent 直接读写云端记忆 · 技能双向同步 · MCP 统一管理
[![version](https://img.shields.io/badge/version-0.9.10-4B7BEC?style=flat-square)](./package.json)
[![license](https://img.shields.io/badge/license-MIT-2ecc71?style=flat-square)](./LICENSE)
[![node](https://img.shields.io/badge/node-%E2%89%A520-339933?style=flat-square&logo=node.js&logoColor=white)](#)
[![platform](https://img.shields.io/badge/platform-DSH%20Web-2B2D42?style=flat-square)](#)
</div>
---
## ✨ 它是什么
dsh-brain 是一个 DSH 插件:一边把 DSH 的对话活动(**只传元数据**)汇入你自托管的 LongMemory,一边把云端记忆库、技能中心变成 agent 随时可用的能力。数据始终留在你自己的服务器上。
## 🚀 主要能力
| 能力 | 你能得到什么 |
| --- | --- |
| 📈 活动上报 | 每个回合结束自动上报一条记录,喂给你自己的活跃热力图;幂等去重、失败自动补发。 |
| 🧰 记忆工具 | agent 直接用 `memory_search` / `memory_read` / `memory_add` / `memory_list` / `memory_projects` 读写云端记忆库。 |
| 🔗 Mnemon 记忆空间 | 作为 Mnemon 的 Provider,长期记忆每次读写都实时穿透到 LongMemory,别处刚写入的内容立刻可召回。 |
| 🧩 技能双向同步 | 云端技能中心 ↔ 本机技能目录自动对账;冲突按内容与时间自动处理,可逐项确认。 |
| 🗂 技能管理 | 插件内即可列表、启停、删除、从 git 安装技能,不必再装第三方管理器。 |
| 🛠 MCP 管理 | 统一管理 MCP 连接、健康检查、启停、重连与目录市场。 |
| 🎛 统一设置卡 | 「连接与上报 / 技能管理 / MCP 管理」三页签,一处配置。 |
## 🔒 隐私:绝不上传
**提示词正文、工具输出、文件内容、本地路径、令牌**都不会上传。上报载荷在类型层面只有 6 个字段(`client_id`、`conversation_id`、`turn_id`、`status`、`started_at`、`completed_at`),构造它的函数拿不到正文。
## 📦 安装
```powershell
# 装进当前 profile(默认 desktop)
dsh plugin --profile desktop add dsh-brain
```
装好后重启 DSH,进入 **设置 → 插件 → 云端记忆** 进行配置。
## ⚡ 快速开始
1. **填服务地址**:把 `baseUrl` 改成你自己的 LongMemory 地址(默认是占位符)。
2. **登录取令牌**:在设置卡填云端「普通用户」账号密码,一键换取两个令牌(密码不落盘)。
3. **开始使用**:对话自动上报;让 agent 调记忆工具;在技能页管理技能。
> 不想用账号登录?也可以直接手填两个令牌。详见 [安装与配置](docs/configuration.md)。
## 🧭 文档
| 文档 | 内容 |
| --- | --- |
| [完整能力与设计](docs/overview.md) | 完整能力清单、上报字段与隐私边界 |
| [安装与配置](docs/configuration.md) | 安装细节、登录流程、全部配置字段与环境变量 |
| [技能同步与管理](docs/skills.md) | 双向同步、内置技能管理、按来源的技能树 |
| [Mnemon 集成](docs/mnemon.md) | 作为记忆空间 Provider 的接入与支持范围 |
| [HTTP 接口与状态语义](docs/http-api.md) | 所有本地接口与上报状态映射 |
| [统一管理卡与 MCP](docs/management.md) | 三页签界面说明、MCP 管理 |
| [故障排查](docs/troubleshooting.md) | 热力图不涨、令牌缺失、网络不可用等 |
| [开发与发布](docs/development.md) | 本地构建、验证脚本、打包发布 |
| [管理接口契约](docs/management-surface.md) | 各接口的真实契约与能力边界 |
| [源码来源](docs/source-provenance.md) | 上游基线与本地改动来源 |
## 🛠 开发
```powershell
pnpm install
pnpm run build
pnpm run typecheck
```
发布流程与发布前闸门见 [开发与发布](docs/development.md)。
## 📄 许可
MIT · 见 [LICENSE](./LICENSE)。