lukaiwuyi/dsh-frontend-tools

dsh-frontend-tools

npm: bridge npm: client

通过回环 WebSocket 将 Web/Electron/Tauri/Node 应用实时桥接到 DeepSeek Harness (DSH) Agent —— 将你的前端工具暴露给 AI Agent。

Demo

设计初衷

大多数 Agent 工具围绕文件系统设计，而现实中数以万计的应用/系统以前端技术构建 —— Agent 无法通过读写文件触达它们。

dsh-frontend-tools 反转了这一模型：不赋予 Agent 直接访问底层数据的能力，而是让接入的应用成为人工操作的分身 —— Agent 通过应用自身的交互入口完成任务，就像坐在屏幕前的一位真人用户。

- 权限对齐 —— Agent 的能力边界与真人用户完全一致，不多一分，真源数据不会被旁路访问。
- 数据流不变 —— 所有操作仍经过应用原有的校验、联动与副作用链路。
- 交互语义保留 —— undo 栈、乐观更新等既有交互机制对 Agent 同样生效。

灵感来自 CopilotKit 的前端工具。本项目的目标：基于 DSH 底座，让任意前端应用/系统能够快速而优雅地接入 Agent。

这是什么？

dsh-frontend-tools 是一个双包项目，让任意 JavaScript 应用（浏览器页面、Electron 渲染进程、Tauri 应用、Node 进程）将自己的函数注册为 DSH Agent 可用的工具，并实时接收来自 Agent 的工具调用。

- dsh-frontend-tools-bridge — DSH 插件：在 DSH 内启动回环 WebSocket 服务。将应用注册的工具镜像到 ctx.tools，并将模型调用转发回去。通过 KEY 命名空间隔离支持多应用同时连接。
- dsh-frontend-tools-client — 应用端 SDK：连接桥接、注册工具、处理入站调用。除平台 WebSocket 外零运行时依赖。

┌─────────────────────┐    WebSocket (127.0.0.1)    ┌──────────────────────┐
│   Your Application  │  ─────────────────────────▶  │   DSH + Bridge       │
│                     │  ◀─────────────────────────  │   (dsh-frontend-     │
│  - generate KEY     │   register tools / calls    │    tools-bridge)     │
│  - register tools   │                              │   - multi-app by KEY │
│  - execute calls    │                              │   - admin tools      │
└─────────────────────┘                              └──────────────────────┘

快速开始

1. 在 DSH 中安装桥接插件

在 DSH 的 cordis.yml 中添加：

plugins:
- import: dsh-frontend-tools-bridge
config:
port: 31870          # optional, default 31870
maxTools: 200        # optional, total tool budget across all apps

然后安装：

pnpm add dsh-frontend-tools-bridge

2. 在应用中安装客户端 SDK

npm install dsh-frontend-tools-client
or pnpm / yarn

3. 连接应用

import { createFrontendToolsClient, generateClientKey } from 'dsh-frontend-tools-client'

// Generate a KEY once, persist it (localStorage or similar)
const key = localStorage.getItem('dsh-key') ?? generateClientKey()
localStorage.setItem('dsh-key', key)

const client = createFrontendToolsClient({ url: 'ws://127.0.0.1:31870', key })
await client.connect()

// Register a tool
await client.registerTools([{
name: 'get_current_page',
description: 'Get information about the current page the user is viewing.',
parametersSchema: { type: 'object', properties: {} },
readOnly: true, // read-only tools run without interruption
async execute() {
return { url: location.href, title: document.title }
},
}])

// Tools WITHOUT readOnly: true are WRITE operations: every call clears
// DSH's human approval before it is forwarded to your app (fail-safe
// default — undeclared means write).

4. 在 DSH 中登记 KEY

1. 应用展示 DSH KEY 给用户（使用 buildClientKeyClipboardText() 生成可直接粘贴的文本）
2. 用户粘贴到 DSH 对话中
3. 模型调用 frontend_tools_register_client 将 KEY 登记到命名空间
4. 完成 — 应用的工具已出现在 Agent 工具列表中

完整 SDK 文档见 dsh-frontend-tools-client，桥接配置、管理工具与协议细节见 dsh-frontend-tools-bridge。

开发

pnpm install
pnpm run build       # build both packages
pnpm run typecheck   # type-check all sources
pnpm run test        # run 175 unit tests

License

MIT