Skip to content

User Guide

zgq edited this page Jul 15, 2026 · 1 revision

User Guide

This page routes common tasks to the maintained product documentation. The Wiki does not duplicate the full tutorials because copied procedures become stale independently of the product docs.

Product documentation

Common tasks

Task Documentation
Install Chat2DB and complete the first-run workflow Getting Started
Connect MySQL, PostgreSQL, Oracle, SQL Server, Redis, and other databases Database Connections
Manage workspaces, database objects, and table data Database Management
Import and export data Import and Export
Use Text2SQL, SQL optimization, and other AI tools AI Chat
Create charts and dashboards Dashboards
Use team collaboration features Teamwork
Install the CLI and work with datasources or SQL CLI Overview
Connect an agent through MCP MCP and Agent Integration

MCP and CLI are different surfaces

  • MCP is a protocol endpoint through which the Chat2DB runtime exposes tools to agents.
  • The chat2db CLI is a separate command-line program for client lifecycle, MCP, datasource, and SQL workflows.
  • The current CLI accepts pro and local as client selections. It does not accept community.
  • Community provides MCP capabilities, but MCP support does not imply that a Community CLI client has been released.

When documentation is missing

Search the product documentation and existing GitHub Discussions first. For a reproducible software defect, collect the information listed in Troubleshooting and open an issue.

Clone this wiki locally