Introduction

One of the core capabilities of DeepSeek Harness (DSH) is extending the ecosystem through plugins. In knowledge management scenarios, integrating reading notes and progress into DSH is a common need. WeRead data is often distributed across client applications, and fetching it with regular crawlers or cookies is unstable and carries risk-control risks.

The weread-export plugin introduced below provides stable data reading and export capabilities by calling the official WeRead Skills Agent Gateway (i.weread.qq.com/api/agent/gateway).

Plugin Overview

Plugin Name: weread-export
Maintainer: zhengjy01
Category: Network Tools
License: MIT

This is a WeRead plugin integrated into DeepSeek Harness. It uses an official API key (starting with wrk-) rather than a cookie-based scraping approach, and can read the bookshelf, highlights/thoughts, and reading statistics. It also supports one-click export to flomo, local Markdown, or Notion.

Installation and Enablement

Run the following command in the terminal to install the plugin:

dsh plugin --profile web add github:zhengjy01/weread-export

After installation is complete, restart the DSH GUI to activate it.

Configuration

The plugin requires an API key and optional flomo credentials.

  1. Open the WeRead Skills configuration page https://weread.qq.com/r/weread-skills and log in with your WeRead account.
  2. Click “Create Key” and copy the key starting with wrk-.
  3. Enter the key in the “WeRead” panel on the DSH Web settings page, or call weread_config in a conversation to configure it.
  4. (Optional) If you want to export to flomo, configure the API URL / API key in the “Flomo” panel.

Configuration information is saved to ~/.dsh/weread-export.json (permissions 0600), and the sync snapshot is saved to ~/.dsh/weread-export-cache.json.

Tools and Usage

The plugin provides multiple agent tools. The following are common commands:

  • weread_config
    Configure or clear the API key, default flomo tag, number of items to export (0 = all), default export target, local directory, Notion token/target page, and so on. Add test: true to test the connection.
  • weread_search
    Search the book store, supporting book title, author, rating, number of active readers, bookId, or link.
  • weread_book
    View book details, reading progress, and a table of contents/chapter overview.
  • weread_shelf
    View the bookshelf, showing book titles, progress, last reading time, and read status (supports real-time or cached mode).
  • weread_notes
    If bookId is not provided, view the notebook overview; if bookId is provided, view the highlights and thoughts for that book.
  • weread_readdata
    View reading statistics (week/month/year/total).
  • weread_sync
    Pull the bookshelf and notebook overview into local cache.
  • weread_flomo
    Quickly export highlights to flomo. Tags can be customized; by default, it exports according to the configured limit (0 = all). Overlong content is automatically split. flomo credentials are reused from dsh-flomo.
  • weread_export
    Multi-target export. The default is dest=flomo; it supports local (requires localDir) or notion (independent token). It can be combined with limit to control the number of items or use LLM templates to organize the output.

Notes

  • WeRead may occasionally require clients to upgrade the skill version. The plugin will display upgrade information at runtime, so you may need to wait for the plugin to update.
  • If flomo is not configured, calling weread_flomo will prompt you to configure credentials first.
  • The API key is stored under the user directory. Pay attention to permission security.

Summary

This plugin connects to WeRead’s core data streams through the official APIs, addressing the pain points of data retrieval and archiving. It is suitable for DSH users who want to persist reading data in flomo or a local note system.