Xiyan MCP Server

🚀 Xiyan-MCP-Server Usage Guide

This guide provides a comprehensive introduction to the configuration and startup methods of the Xiyan-MCP-Server, helping you quickly get started with using this service.

📦 Installation Guide

Model Configuration

Execute the following command to start the local server:

python local_xiyan_server.py

Database Configuration

MySQL

Configure the MySQL database by modifying the following YAML file:

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

PostgreSQL

Step 1: Install the Python package

pip install psycopg2

💻 Usage Examples

Claude Desktop

Add the following content to the Claude Desktop configuration file. Refer to claude_desktop.jpg

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

⚠️ Important Note

The Python command here requires the full executable path (e.g., /xxx/python), otherwise, the Python interpreter cannot be found. The same applies to other applications.

Cline

Prepare the configuration file by referring to Claude Desktop

Goose

Add the following content to the configuration. Refer to goose.jpg

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

📄 Citation

If you find our work helpful, please feel free to cite it.

@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}
}