XiYan MCP Server

<h1 align="center">XiYan MCP Server</h1>
<p align="center">
<a href="https://github.com/XGenerationLab/XiYan-SQL"></a>
</p>
<p align="center">
<b>A Model Context Protocol (MCP) server that enables natural language queries to databases</b><br/>
_{powered by <a href="https://github.com/XGenerationLab/XiYan-SQL" >XiYan-SQL</a>, SOTA of text-to-sql on open benchmarks}
</p>
<p align="center">
💻 <a href="https://github.com/XGenerationLab/xiyan_mcp_server" >XiYan-mcp-server</a> |
🌐 <a href="https://github.com/XGenerationLab/XiYan-SQL" >XiYan-SQL</a> |
📖 <a href="https://arxiv.org/abs/2507.04701"> Arxiv</a> |
🏆 <a href="https://github.com/XGenerationLab/XiYanSQL-QwenCoder" >XiYanSQL Model</a> |
📄 <a href="https://paperswithcode.com/paper/xiyan-sql-a-multi-generator-ensemble" >PapersWithCode</a>
🤗 <a href="https://huggingface.co/collections/XGenerationLab/xiyansql-models-67c9844307b49f87436808fc">HuggingFace</a> |
🤖 <a href="https://modelscope.cn/collections/XiYanSQL-Models-4483337b614241" >ModelScope</a> |
🌕 <a href="https://bailian.console.aliyun.com/xiyan">析言GBI</a>
<br />

<a href="https://arxiv.org/abs/2411.08599"></a>
<a href="https://opensource.org/licenses/Apache-2.0">

</a>
<a href="https://pepy.tech/projects/xiyan-mcp-server"></a>

<a href="https://smithery.ai/server/@XGenerationLab/xiyan_mcp_server"></a>
<a href="https://github.com/XGenerationLab/xiyan_mcp_server" target="_blank">

</a>
<br />
<a href="https://github.com/XGenerationLab/xiyan_mcp_server" >English</a> | <a href="https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/README_zh.md"> 中文 </a> | <a href="https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/README_ja.md"> 日本語 </a><br />
<a href="https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/imgs/dinggroup_out.png">Ding Group钉钉群</a>｜
<a href="https://weibo.com/u/2540915670" target="_blank">Follow me on Weibo</a>
</p>

Table of Contents

- Features
- Preview
- Architecture
- Best Practice
- Tools Preview
- Installation
- Installing from pip
- Installing from Smithery.ai
- Configuration
- LLM Configuration
- General LLMs
- Text-to-SQL SOTA model
- Local Model
- Database Configuration
- MySQL
- PostgreSQL
- Launch
- Claude Desktop
- Cline
- Goose
- Cursor
- It Does Not Work
- Citation

Features

Preview

Architecture

Best practice and reports

"Build a local data assistant using MCP + Modelscope API-Inference without writing a single line of code"

"Xiyan MCP on Modelscope"

Evaluation on MCPBench

Tools Preview

- The {dialect}://{table_name} resource allows obtaining a portion of sample data from the database for model reference when a specific table_name is specified.
- The {dialect}:// resource will list the names of the current databases

pip install xiyan-mcp-server

pip install git+https://github.com/XGenerationLab/xiyan_mcp_server.git

mcp:
  transport: "stdio"
model:
  name: "XGenerationLab/XiYanSQL-QwenCoder-32B-2412"
  key: ""
  url: "https://api-inference.modelscope.cn/v1/"
database:
  host: "localhost"
  port: 3306
  user: "root"
  password: ""
  database: ""

mcp:
  transport: "stdio"

mcp:
  transport: "sse"
  port: 8000
  log_level: "INFO"

Other configurations like debug, host, sse_path, message_path can be customized as well, but normally you don't need to modify them.

model:
  name: "gpt-3.5-turbo"
  key: "YOUR KEY "
  url: "https://api.openai.com/v1"
database:

model:

  name: "qwen-max"

  key: "YOUR KEY "

  url: "https://dashscope.aliyuncs.com/compatible-mode/v1"

database:

model:
  name: "XGenerationLab/XiYanSQL-QwenCoder-32B-2412"
  key: ""
  url: "https://api-inference.modelscope.cn/v1/"

We deployed the model on Alibaba Cloud DashScope, so you need to set the following environment variables:
Send me your email to get the key. ( godot.lzl@alibaba-inc.com )
In the email, please attach the following information:


name: "YOUR NAME",

email: "YOUR EMAIL",

organization: "your college or Company or Organization"

model:
  name: "xiyansql-qwencoder-32b"
  key: "KEY"
  url: "https://xiyan-stream.biz.aliyun.com/service/api/xiyan-sql"

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

pip install psycopg2

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

Note that dialect should be postgresql for postgresql.


Launch

If you want to launch server with sse, you have to run the following command in a terminal:


YML=path/to/yml python -m xiyan_mcp_server

Otherwise, if you use stdio transport protocol, you usually declare the mcp server command in specific mcp application instead of launching it in a terminal.
However, you can still debug with this command if needed.

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

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

For stdio:


{

  "mcpServers": {

    "xiyan-mcp-server": {

      "command": "/xxx/python",

      "args": [

        "-m",

        "xiyan_mcp_server"

      ],

      "env": {

        "YML": "path/to/yml"

      }

    }

  }

}

{

  "mcpServers": {

    "xiyan_mcp_server_1": {

      "url": "http://localhost:8000/sse"

    }

  }

}

Witsy

/xxx/python -m xiyan_mcp_server

Contact us:

Contact Information:

Yifu Liu, zhencang.lyf@alibaba-inc.com

Join Our DingTalk Group

<a href="https://github.com/XGenerationLab/XiYan-SQL/blob/main/xiyansql_dingding.png">Ding Group钉钉群</a>

Other Related Links

Citation

@article{XiYanSQL,
      title={XiYan-SQL: A Novel Multi-Generator Framework For Text-to-SQL}, 
      author={Yifu Liu and Yin Zhu and Yingqi Gao and Zhiling Luo and Xiaoxia Li and Xiaorong Shi and Yuntao Hong and Jinyang Gao and Yu Li and Bolin Ding and Jingren Zhou},
      year={2025},
      eprint={2507.04701},
      archivePrefix={arXiv},
      primaryClass={cs.CL},
      url={https://arxiv.org/abs/2507.04701}, 
}