omdsh-dev/dsh-data-agent

中文 | English

Highlights · Quick Start · Use Cases · Workbench & Reports · Supported Data Sources · Security & Privacy · FAQ · License

Product Highlights

Tired of filing data requests, wrestling with complex SQL queries, exporting CSVs back and forth into Excel, and trying to decipher cryptic column abbreviations across hundreds of tables?

DSH Data Agent brings data analysis back to business decision-making:

• 💬 Zero-Barrier Conversational Analysis: Ask business questions in plain language (e.g., "Compare channel conversion rates over the last 30 days"). AI automatically understands business intent, discovers relevant schemas, writes and executes SQL, iterates on results, and delivers clear conclusions.
• 📊 Smart Charts & Interactive Dashboards: Say goodbye to plain text and raw tables. Automatically generate line charts, bar charts, pie charts, scatter plots, or multi-view dashboards, and export standalone offline HTML reports for effortless sharing.
• 🧠 Deep Business Insights: Go beyond raw metrics. The agent pinpoints anomaly drivers, detects sales drops, identifies high-value customer cohorts, and translates cold numbers into actionable business recommendations.
• 🏷️ AI-Powered Metric & Schema Governance: Automatically scans databases to generate intuitive business explanations for tables and fields. Supports human review and custom metric definitions, ensuring every query relies on unified, accurate business definitions.
• 🔒 Local Security & Read-Only Protection: Built-in support for read-only database accounts and read-only mode. All queries run locally with strict credential protection—your production data stays safe and confidential.
• 🖥️ Modern Web & High-Efficiency Terminal: Use the intuitive Web UI to configure connections and explore charts visually, or switch to the keyboard-first terminal interface (dsh-tui) for rapid command-line workflows.

Quick Start

1. Prerequisites

• DeepSeek Harness 0.1.7-rc.1 (the target of source version 0.2.0; all official @deepseek-ai/dsh-* dependencies are pinned to this version)
• Accessible database (local SQLite file or remote/cloud database)

2. Quick Install

Run the following command to install the plugin directly from npm:

# Install for Web UI (Recommended)
dsh plugin --profile web add @yejiming/dsh-data-agent

# Or install for Terminal UI (dsh-tui)
dsh plugin --profile dsh-tui add @yejiming/dsh-data-agent

3. Start Analyzing

This version declares Data Mode through dsh-agent-preset-registry instead of the removed standingKeyFor() API. It still reads presets from $DSH_HOME/.agent-presets/<presetId>/; the host registry owns tool scopes, blank-session switching, and disposal. Existing customized presets and names are preserved. installPreset: false disables this plugin's preset installation and registration; another host plugin must declare the preset. Use a matching older plugin release with older DSH hosts.

On the first start after a plugin upgrade, recognized, unmodified legacy data-agent presets are updated automatically to supply the persona.config.prefix required by newer DSH versions while retaining the existing text field. Customized presets are never overwritten. If startup reports $.prefix missing required value, back up $DSH_HOME/.agent-presets/data-agent/agent.cordis.yml (DSH_HOME defaults to ~/.dsh), give prefix the same prompt as the existing text in the persona config, and restart.

Method 1: Web Interface (Recommended)

Start the Web console, create a new session, and select "Data Mode":

dsh --profile web

1. On the New Session screen, click Connection Settings beside Data Mode; after the session opens, you can use the Database icon in the top-right of the composer. Fill in your connection details in the same workbench (supports connection testing);
2. Once connected, ask your business analysis question directly in the chat box;
3. Ask follow-up questions to drill down deeper based on preliminary conclusions.

Method 2: Terminal Interface (dsh-tui)

Ideal for keyboard-first and terminal users:

dsh --profile dsh-tui

Enter /preset data-agent to switch to Data Mode, and /database connect to connect your database and start asking questions.

Use Cases

Scenario	Prompt Example
📈 Sales & Revenue Review	"Analyze revenue and MoM growth by channel over the last 30 days, identify the product categories with the steepest decline, and explain the key drivers."
👥 User Segmentation & RFM	"Perform RFM segmentation on members based on purchase frequency and average order value over the past 6 months, and report retention rates for each tier."
🛒 Funnel & Conversion Analysis	"Calculate monthly user conversion rates from registration, search, and add-to-cart to checkout, and highlight the stage with the highest drop-off rate."
📦 Inventory & Supply Chain	"Inspect SKUs with inventory turnover exceeding 60 days, and forecast stockout or overstock risks based on recent sales velocity."
📑 Executive Weekly Summary	"Summarize last week's core metrics (GMV, active users, average order value) and write a concise briefing suitable for the management group chat."

Workbench & Reports

1. All-in-One Database Workbench

The Web UI features an integrated database workbench with four core modules: Connection Config, Schema Browser, Data Governance, and SQL Runner, making it easy to inspect data assets at any time.

2. AI-Assisted Data Governance

Open the "Data Governance" tab in the workbench, and AI will scan table schemas to generate clear business descriptions. Review, refine, and add custom metrics so team members never have to guess column meanings again.

3. Interactive Offline Analysis Reports

When an analysis benefits from visual presentation, the agent generates single charts or multi-metric dashboards and automatically saves standalone HTML reports under analysis-reports/. Includes interactive charts, KPI cards, and raw data tables—ready to open offline in any browser or share with colleagues.

Supported Data Sources

DSH Data Agent supports a wide variety of relational databases, analytical data warehouses, and local files:

• 🐬 Relational Databases: MySQL, PostgreSQL, SQLite, Oracle, Microsoft SQL Server
• ⚡ Analytical Warehouses / OLAP: ClickHouse, Apache Doris, Apache Hive, Apache Impala
• 📁 Local & Lightweight Data: SQLite data files (zero-config, out-of-the-box)

Security & Privacy

• 🛡️ Strict Read-Only Protection: Use a read-only database account and enable "Read-Only Mode" to prevent accidental data modification or deletion.
• 🔑 Credential Isolation: Database passwords are used strictly in the current runtime session, never written to plain-text logs, and never sent to external servers.
• 💻 100% Local Execution: Query execution and report generation happen entirely on your local machine, keeping business data private and secure.

FAQ

License

This project is licensed under the MIT License.

Related Links

• dshfind.com: DeepSeek Harness plugin and ecosystem discovery community
• dsh-web-ui: Extensible Web UI for DeepSeek Harness
• dsh-cc-tui: Keyboard-first terminal interface for DeepSeek Harness
• platonai/Browser4: AI-native browser engine for autonomous agents and large-scale web automation