Xiyansql (MySQL)

🚀 xiyan_mcp_server Usage Instructions

This document provides a detailed guide on configuring and using the xiyan_mcp_server, including server setup, database configuration, startup methods, tool integration examples, and issue reporting channels.

🚀 Quick Start

Server Configuration

Environment Preparation

Ensure that Python and the required dependencies are installed.

Configuration File Example

model:
  name: "xiyansql-qwe"
  key: "KEY"
  url: "http://localhost:5090"

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: ""
  database: ""

Startup Command

python local_xiyan_server.py

Database Configuration

MySQL Configuration Example

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: ""
  database: ""

PostgreSQL Configuration Steps

1. Install dependencies:

   pip install psycopg2
   

2. Configuration file example:

   database:
     dialect: "postgresql"
     host: "localhost"
     port: 5432
     user: ""
     password: ""
     database: ""
   

Startup Methods

Using Claude Desktop

Add the following content to the configuration file:

{
    "mcpServers": {
        "xiyan-mcp-server": {
            "command": "/xxx/python",
            "args": [
                "-m",
                "xiyan_mcp_server"
            ],
            "env": {
                "YML": "PATH/TO/YML"
            }
        }
    }
}

Using the Command Line

Prepare the configuration file and run:

python -m xiyan_mcp_server

💻 Usage Examples

Tool Integration Examples

Goose Configuration Example

Add the following content to the configuration:

env YML=path/to/yml /xxx/python -m xiyan_mcp_server

Witsy Configuration Example

Add the following content to the command:

/xxx/python -m xiyan_mcp_server

And set the environment variable:

YML=path/to/yml

📚 Documentation

Issue Reporting

If you encounter any issues, please contact us through the following channels: DingTalk Group | Follow us on Weibo

Citation Instructions

If you use this project, please cite the following literature:

@article{xiyansql,
      title={A Preview of XiYan-SQL: A Multi-Generator Ensemble Framework for Text-to-SQL}, 
      author={Yingqi Gao and Yifu Liu and Xiaoxia Li and Xiaorong Shi and Yin Zhu and Yiming Wang and Shiqi Li and Wei Li and Yuntao Hong and Zhiling Luo and Jinyang Gao and Liyu Mou and Yu Li},
      year={2024},
      journal={arXiv preprint arXiv:2411.08599},
      url={https://arxiv.org/abs/2411.08599},
      primaryClass={cs.AI}
}