Overview
Features
NL-based data retrieval via XiYanSQL
Fetch data from databases using natural language queries with XiYanSQL as the text-to-SQL engine.
Supports multiple LLMs and SOTA text-to-SQL model
Supports general LLMs (GPT, qwenmax) and XiYanSQL-QwenCoder-32B-2412 via Modelscope or Dashscope, including local options.
Local mode for high security
Pure local mode that does not require API keys for operation.
Database dialect support (MySQL & PostgreSQL)
Configures connections for MySQL and PostgreSQL and uses dialect-specific settings (postgresql for PostgreSQL).
Resource discovery and data preview
List available tables as resources and preview data via dialect://{table_name} and similar resources.
Two integration modes: Remote and Local
Architecture supports remote mode with API-backed NL-to-SQL and local mode for secure, self-contained use.
Configurable via YAML with transport options
Configure mcp transport (stdio or SSE), model, and database in YAML; includes example defaults and launch commands.
Data tooling for NL queries
Includes a get_data tool to translate NL to SQL and execute queries, returning results.




