Introduction¶
DeepSeek Harness (DSH) uses a plugin-based architecture. Native clients (such as dsh-native) often need to access project and session metadata but cannot directly load or fetch the Harness Web UI. dsh-companion aims to address this type of scenario.
Plugin Scope¶
This is a plugin maintained by leonardoxr that provides read-only JSON views, configurable notification event streams, and a Web settings card for DeepSeek Harness native clients.
Core Features¶
- JSON Endpoints: Provides three small, uncached JSON endpoints to retrieve workspace and live session information.
- Workspace Browser: When the page runs in DSH Native, it displays a unified workspace browser in the Harness left sidebar.
- Notification Stream: Provides a reconnectable Server-Sent Events (SSE) stream to receive native completion, failure, issue, and approval alerts.
- Settings Card: Provides a settings card in the Web UI to filter alert types and sub-agent events.
- Images Tab: An optional Images tab integrated with the
dsh-better-sidebarworkbench. - Security and Projection: Uses explicit field projection to avoid serializing internal Harness objects, and enforces DSH trusted-host and same-origin checks on every request.
Installation and Enablement¶
First, install the plugin into the Web profile:
dsh plugin --profile web add github:leonardoxr/dsh-companion
After starting the Web interface, verify that the plugin is available with the following command:
curl http://127.0.0.1:3080/api/companion/workspaces
Typical Usage¶
In the Harness Web UI, open Settings → Plugins → DSH Companion notifications to configure notification settings.
Notes¶
- This project is not the unscoped
dsh-companionpackage on npm. - Do not expose the DSH server to networks that should not read this metadata.
- This is a network trust boundary, not a user authentication mechanism.
Ecosystem and Source¶
The plugin follows the MIT License. For more details and source code, visit:
* GitHub: https://github.com/leonardoxr/dsh-companion
* Plugin Directory: https://www.skillhub.cn/plugins/leonardoxr/dsh-companion