Passer au contenu principal
X

dsh-web-search-plugin

x-c1811/dsh-web-search-plugin

Unified web search for the DeepSeek Harness seam (ctx.web): DeepSeek (official), Tavily, and Brave backends with an in-browser selector

Installer

dsh plugin --profile web add github:x-c1811/dsh-web-search-plugin

README

dsh-web-search-plugin

面向 DeepSeek Harness web 能力接缝(ctx.web)的统一网页搜索插件,内置 DeepSeek(官方)/ Tavily / Brave Search 三个后端。本包只向接缝注册 一个 WebSearchProvider,稳定 id 为 dsh-web-search。在设置卡里切换引擎即可,不必再改 web.searchProvider

  • DeepSeek(官方) — 走 DeepSeek 的 Anthropic 兼容 Messages API(原生 web_search_20250305 工具,凭据名 DEEPSEEK_API_KEY),一次搜索消耗一个模型轮次。
  • Tavily(默认)keyless(免费、限流、无需账号)或 keyedTAVILY_API_KEY,Bearer token)。
  • Brave SearchGET https://api.search.brave.com/res/v1/web/search,请求头 X-Subscription-Token(凭据名 BRAVE_API_KEY)。一次搜索就是一次 HTTP 请求,不走模型轮次。
  • 不写自定义 session 事件 — 工具结果已经走接缝自己的事件,无需多余信封。

特性

  • 与官方 @deepseek-ai/dsh-web-search-deepseek 相同的提供方约定:inject: ['web'] + installSettingsSection + ctx.web.registerSearchProvider
  • Tavily keyless 无需密钥即可用;Brave 需要订阅 token(若本机已有 BRAVE_API_KEY 凭据,可直接复用)。
  • 各引擎结果都规范化为接缝的 WebSearchResult(可选 content + sources[]),按 URL 去重。
  • 设置段 dsh-web-search-plugin 通过 rc.7 的 settings.describe() 动态暴露,不需要宿主白名单补丁,也不需要自建回环 settings 桥。
  • 错误映射为 WEB_PROVIDER_ERROR / WEB_ABORTED / WEB_PROVIDER_CREDENTIAL_MISSING

运行要求

  • DeepSeek Harness 0.1.0-rc.7 或更新
  • pnpm,用于通过 dsh plugin 把插件装进 profile

安装

本包是 bundledsh.bundle.patch + cordis.patch.yml 会插入 Host 行、把 web.searchProvider 设为 dsh-web-search,并禁用内置 web-search-deepseek Host 插件(本插件已自行托管 DeepSeek 后端,禁用它能移除旧的「插件 → 网页搜索」卡片、避免重复注册 provider)。没有这一声明时,dsh plugin add 只写入依赖,插件不会挂载。

从 npm 安装

dsh plugin --profile web add dsh-web-search-plugin

从本地目录安装

dsh plugin --profile web add "path/to/dsh-web-search-plugin"

重启 DSH web 进程;浏览器刷新后会加载客户端 bundle。

dsh --profile web --dump-config 确认:组成树里应有 dsh-web-search-plugin 行,且 web.searchProviderdsh-web-search

若 profile 已经覆盖了 web(例如旧包 @dsh-ltctfer/dsh-web-search-brave 留下的 brave-official),后打的 patch 仍会生效。请改指向本插件,并卸掉旧包:

- id: web
  name: '@deepseek-ai/dsh-web'
  config:
    searchProvider: dsh-web-search
dsh plugin --profile web remove @dsh-ltctfer/dsh-web-search-brave

然后在 设置 → 网页搜索 里把引擎切到想要的提供方,即可继续使用对应的 API key。

关于 file:(本地)安装 — pnpm 会把 file:path 依赖做成快照。改完本仓库后,需要再执行一次 dsh plugin --profile web add "path/to/dsh-web-search-plugin" 并重启。

配置

设置卡编辑的是 dsh-web-search-plugin 命名空间:

默认值含义
providertavilytavilybravedeepseek-official
modekeyless仅 Tavily:keylesskeyed
apiKeyTavily API key 字面量(走凭据域,不会回显)
apiKeyEnvTAVILY_API_KEYkeyed Tavily 使用的凭据/环境变量名
baseURLhttps://api.tavily.comTavily REST 基址;会再拼 /search
maxResults8每次搜索返回的源数量(1–20),三个后端共用
searchDepthbasic仅 Tavily:basicadvanced
includeAnswertrue仅 Tavily:请求生成摘要,写入结果 content
topicgeneral仅 Tavily:generalnews
deepseekApiKeyDeepSeek API key 字面量(走凭据域)
deepseekApiKeyEnvDEEPSEEK_API_KEYDeepSeek 使用的凭据/环境变量名
deepseekBaseURLhttps://api.deepseek.com/anthropic/v1DeepSeek Anthropic 兼容 Messages 基址;再拼 /messages
modeldeepseek-v4-flashAnthropic 格式模型名
apiVersion2023-06-01anthropic-version 请求头
maxTokens4096Messages 请求生成 token 上限
maxUses5每次请求 web_search 工具的最大调用次数
braveApiKeyBrave 订阅 token 字面量(走凭据域)
braveApiKeyEnvBRAVE_API_KEYBrave 使用的凭据/环境变量名
braveBaseURLhttps://api.search.brave.com/res/v1/web/searchBrave 网页搜索接口
countryBrave 的 country(ISO 两位码,如 cn
searchLangBrave 的 search_lang(如 zh-hans
freshnessBrave 的 freshnesspd / pw / pm / py
proxyBrave 使用的 HTTP(S) 代理;未填则回退 HTTPS_PROXY / HTTP_PROXY

环境变量:启动时 DSH_WEB_SEARCH_PROVIDER=dsh-web-search 会选中本接缝 id。未设置 baseURL 时,Tavily 基址回退 $TAVILY_BASE_URL

切回内置 DeepSeek

DeepSeek 已并入本插件(provider: deepseek-official),无需切回。若确要恢复 DSH 内置的 DeepSeek host 插件,请在 profile patch 里去掉对 web-search-deepseekdisabled 并把 searchProvider 设回 deepseek-official;本插件可以继续挂着,只是不会被选中。

工作方式

  • DeepSeekPOST {deepseekBaseURL}/messages,请求头 x-api-key / authorization: Bearer,工具 web_search_20250305
  • TavilyPOST {baseURL}/search。keyless 发送 x-tavily-access-mode: keyless;keyed 发送 authorization: Bearer <key>
  • BraveGET {braveBaseURL}?q=&count=,请求头 x-subscription-token。不向 session 追加自定义事件。
  • 非 2xx 映射为 WEB_PROVIDER_ERROR;调用方取消映射为 WEB_ABORTED

仓库布局

lib/index.js       Host 插件:Config、分发提供方、设置段
lib/deepseek.js    DeepSeek 后端(Anthropic Messages + web_search_20250305)
lib/tavily.js      Tavily 后端
lib/brave.js       Brave 后端(不写自定义 session 事件)
lib/shared.js      中止 / 凭据解析辅助
lib/client.js      浏览器 bundle:顶层「网页搜索」分区 + 引擎切换表单
cordis.patch.yml   Bundle patch:插入 Host 行、设 searchProvider、禁用内置 deepseek

开发

npm run check

客户端 bundle 必须保持 window.__ModuleLoader__.load({ id, factory }) 线格式 — 由 dsh-client-modules 加载,不是打包器。必须同时导出 applyinjectslotslocaleconnectionremotesettingsScope),并把分区注册进 settings.sectionid: "web-search")。

发布

发布由 GitHub Actions(.github/workflows/publish.yml)自动完成:推送 v* 标签(例如 v0.2.0)会带 provenance 发到 npm。向 main 的普通推送不会发布。

  1. 确认 package.jsonversion 与即将推送的标签一致(例如 0.2.0v0.2.0)。

  2. 在 GitHub Settings → Secrets and variables → Actions 里配置有 publish 权限的 npm automation token(仓库密钥 NPM_TOKEN),并允许 Actions 运行。

  3. 打标签并推送:

    git tag v0.2.0
    git push origin v0.2.0
    

工作流会先核对标签与 package.jsonversion,再执行 npm publish --provenance --access public

参与贡献

欢迎提 issue 和 pull request,见 issue tracker。还可以在同一接缝 id 下继续加搜索后端。

许可证

MIT

Plugins associés