XiYan MCP Server

XiYan MCP Server

A Model Context Protocol (MCP) server that enables natural language queries to databases

powered by XiYan-SQL, SOTA of text-to-sql on open benchmarks

💻 XiYan-mcp-server | 🌐 XiYan-SQL | 📖 Arxiv | 🏆 XiYanSQL Model | 📄 PapersWithCode 🤗 HuggingFace | 🤖 ModelScope | 🌕 析言GBI

英语 | 中文 | 日本语

Ding Group钉钉群｜ 在微博上关注我

目录

• 特性
• 预览

- 建筑 - 最佳实践 - 工具预览

• 安装

- 从pip安装 - 从Smithery.ai安装

• 配置

- LLM配置 - 普通法学硕士 - 文本转换为SQL SOTA模型 - 本地模型 - 数据库配置 - MySQL - PostgreSQL

• 发射

- 克劳德桌面 - 克莱恩 - 鹅 - 光标

• 它不起作用
• 引用

特性

• 🌐 通过自然语言获取数据 XiYanSQL
• 🤖 支持通用LLM（GPT、qwenmax）、文本到SQL SOTA模型
• 💻 支持纯本地模式（高安全性！）
• 📝 支持MySQL和PostgreSQL。
• 🖱️ 将可用表列为资源
• 🔧 读取表格内容

预览

建筑

有两种方法可以将此服务器集成到您的项目中，如下所示： 左侧是远程模式，这是默认模式。它需要一个API密钥来访问来自服务提供商的xiyanSQL-qwencoder-32B模型（请参见 配置). 另一种模式是本地模式，它更安全。它不需要API密钥。

最佳做法和报告

“使用MCP+Modelscope API-Inference构建本地数据助理，无需编写单行代码”

“Xiyan MCP on Modelscope”

MCPBench的评价

工具预览

• 工具 get_data 提供用于从数据库检索数据的自然语言接口。此服务器将使用内置模型将输入的自然语言转换为SQL，并调用数据库以返回查询结果。

• 这 {dialect}://{table_name} 当指定了特定的table_name时，资源允许从数据库中获取一部分示例数据以供模型参考。

• 这 {dialect}:// 资源将列出当前数据库的名称

安装

从pip安装

Python 3.11+是必需的。 您可以通过pip安装服务器，它将安装最新版本：

pip install xiyan-mcp-server

如果你想从源代码安装开发版本，你可以从github上的源代码安装：

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

从Smithery.ai安装

看 @XGeneration实验室/西安_mcp_server

未完全测试。

配置

您需要一个YAML配置文件来配置服务器。 config_demo.yml中提供了一个默认配置文件，如下所示：

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配置

您可以将传输协议设置为 stdio 或 sse.

工作室

对于stdio协议，您可以这样设置：

mcp:
  transport: "stdio"

上海证券交易所

对于sse协议，您可以按如下方式设置mcp配置：

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

默认端口为 8000。如果需要，您可以更改端口。 默认日志级别为 ERROR。我们建议将日志级别设置为 INFO 了解更多详细信息。

其他配置，如 debug, host, sse_path, message_path 也可以定制，但通常不需要修改它们。

LLM配置

Name 是要使用的模型的名称， key 是模型的API密钥， url 是模型的API url。我们支持以下型号。

普通法学硕士

如果你想使用通用的LLM，例如gpt3.5，你可以直接这样配置：

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

如果你想使用阿里巴巴的Qwen，例如Qwen-max，你可以使用以下配置：

model:
  name: "qwen-max"
  key: "YOUR KEY "
  url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
database:

文本转换为SQL SOTA模型

我们推荐XiYanSQL-qwencoder-32B(https://github.com/XGenerationLab/XiYanSQL-QwenCoder)，这是text-to-sql中的SOTA模型，请参阅 鸟类基准. 有两种方法可以使用该模型。你可以使用它们中的任何一个。 (1) 模型范围（2）阿里云DashScope。

（1） 模型范围版本

你需要申请 key 来自Modelscope的API引用，https://www.modelscope.cn/docs/model-service/API-Inference/intro 然后，您可以使用以下配置：

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

阅读我们的 模型描述 了解更多详情。

（2） Dashscope版本

我们在阿里云DashScope上部署了该模型，因此您需要设置以下环境变量： 请将您的电子邮件发送给我以获取 key. ( godot.lzl@alibaba-inc.com ) 请在电子邮件中附上以下信息：

name: "YOUR NAME",
email: "YOUR EMAIL",
organization: "your college or Company or Organization"

我们将向您发送 key 根据您的电子邮件。你可以填写 key 在yml文件中。 这 key 将过期1个月或200次查询或其他法律限制。

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

注意：此型号服务仅供试用，如果您需要在生产中使用，请联系我们。

（3） 本地版本

或者，您也可以部署模型 西安SQL-qwencoder-32B 在您自己的服务器上。 看 本地模型 了解更多详情。

数据库配置

host, port, user, password, database 是数据库的连接信息。

您可以使用本地或任何远程数据库。现在我们支持MySQL和PostgreSQL（更多方言即将推出）。

MySQL

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

PostgreSQL

第一步：安装Python包

pip install psycopg2

步骤2：准备config.yml，如下所示：

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

请注意 dialect 应 postgresql 对于postgresql。

发射

服务器启动

如果你想用启动服务器 sse，您必须在终端中运行以下命令：

YML=path/to/yml python -m xiyan_mcp_server

然后，您应该看到以下信息http://localhost:8000/sse在您的浏览器中。（默认情况下，如果您的mcp服务器在其他主机/端口上运行，请更改）

否则，如果您使用 stdio 在传输协议中，您通常在特定的mcp应用程序中声明mcp-server命令，而不是在终端中启动它。 但是，如果需要，您仍然可以使用此命令进行调试。

客户端设置

克劳德桌面

将此添加到您的Claude Desktop配置文件ref中 Claude桌面配置示例

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

请注意，这里的Python命令需要Python可执行文件的完整路径(/xxx/python)；否则，找不到Python解释器。您可以使用以下命令确定此路径 which python这同样适用于其他应用程序。

Claude Desktop目前不支持SSE传输协议。

克莱恩

像这样准备配置 克劳德桌面

鹅

如果你使用 stdio，在配置中添加以下命令，ref Goose配置示例

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

否则，如果您使用 sse，将类型更改为 SSE 并将端点设置为 http://127.0.0.1:8000/sse

光标

使用类似的命令，如下所示。

对于 stdio:

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

对于 sse:

{
  "mcpServers": {
    "xiyan_mcp_server_1": {
      "url": "http://localhost:8000/sse"
    }
  }
}

机智

在命令中添加以下内容：

/xxx/python -m xiyan_mcp_server

添加一个env:key是YML，value是YML文件的路径。 参考 Witsy配置示例

联系我们：

如果您对我们的研究或产品感兴趣，请随时与我们联系。

联系方式：

刘，zhencang.lyf@alibaba-inc.com

加入钉钉集团

Ding Group钉钉群

其他相关链接

引用

如果你觉得我们的工作有帮助，请随时给我们一个引用。

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