Xgenerationlab Xiyan MCP Server

🚀 xiyan_mcp_server

The xiyan_mcp_server is a server-side tool designed to run the XiYan-SQL model, which specializes in converting natural language into Structured Query Language (SQL). This document will guide you through the configuration and operation of this server.

🚀 Quick Start

✨ Features

• Support for multiple remote models.
• Options to run the model locally.
• Compatibility with various platforms such as Claude Desktop, command line (Goose), Cursor, and Witsy.

📦 Installation

Remote Model

We support the following remote models:

1. Model Name: xiyansql-qwencoder-3b
   • This version is recommended for its excellent performance.
2. Model Name: xiyansql-qwencoder-3b

Local Model

If you prefer to run the model locally, follow these steps:

1. Hardware Requirements:
   • CPU: At least 16GB of RAM.
   • Storage Space: At least 6GB of available space.
2. Install Dependencies:

pip install flask modelscope torch==2.2.2 accelerate>=0.26.0 numpy=2.2.3

3. Download the Model (Optional):
   • It is recommended to download the xiyansql-qwencoder-3b model.

modelscope download --model XGenerationLab/XiYanSQL-QwenCoder-3B-2502

4. Run the Server:

python local_xiyan_server.py

The server will run at http://localhost:5090/.

Configuration Example

Your configuration file (config.yml) should look like this:

model:
  name: "xiyansql-qwencoder-3b"
  key: "KEY" # Replace with your key
  url: "http://127.0.0.1:5090"

Database Configuration

Here is the database connection information:

database:
  host: "localhost" # Database address
  port: 3306       # Database port
  user: "root"     # Database username
  password: ""      # Database password
  database: ""      # Database name

Startup Methods

On Claude Desktop

Add the following content to your Claude desktop configuration file:

{
    "mcpServers": {
        "xiyan-mcp-server": {
            "command": "python",
            "args": [
                "-m",
                "xiyan_mcp_server"
            ],
            "env": {
                "YML": "PATH/TO/YML" # Replace with the path to your config.yml
            }
        }
    }
}

On the Command Line (Goose)

Add the following content to the configuration file:

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

On Cursor

Use the same method as for Goose.

On Witsy

Add the following command:

python -m xiyan_mcp_server

And set the environment variable:

• Variable Name: YML
• Variable Value: The path to your config.yml

Encountered Issues?

Contact us via the following link for assistance: GitHub Repository

⚠️ Important Note

Before running the server, ensure that all configuration information is correct and the database service is running.