text2sql实现之xiyan_mcp_server

xiyan_mcp_server是一个实现使用自然语言查询数据库的服务器（工具），核心核心技术是 MCP 协议和 XiYan-SQL模型

一、环境说明

操作系统：win11-x64

python：3.11

模型：XGenerationLab/XiYanSQL-QwenCoder-32B-2412（来源魔塔社区）

二、安装xiyan_mcp_server

1、创建python环境

使用conda的anaconda prompt终端创建python环境（注意需要先安装anaconda工具）

命令：conda create -n xiyan python=3.11

2、切换到xiyan环境

命令：conda activate xiyan

3、安装xiyan_mcp_server

命令：pip install xiyan_mcp_server

4、修改配置文件

在xiyan python环境中找到下载的xiyan_mcp_server包，我的路径是：D:\soft\anaconda3\envs\xiyan\Lib\site-packages\xiyan_mcp_server，找到config_demo.yml文件

打开config_demo.yml，配置模型和数据库信息，我这里用的是mysql，可以参考下面内容，根据自己的mysql数据库修改

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

database:
  host: "数据库IP地址"
  port: 数据库端口号
  user: "用户名"
  password: "密码"
  database: "库名"

model中的key需要在魔塔中查找，可以使用已有的，也可以新创建一个，地址：ModelScope 魔搭社区 

5、启动xiyan_mcp_server

命令：python -m xiyan_mcp_server

执行结果如上图，后续就没什么反应了，这个状态应该就是没问题的。

注：可以跳过第三、四步

三、安装node

跳过此步骤不知道对第五步cherry studio配置xiyan_mcp_server会不会有影响，安装步骤参考：windows下安装并使用node.js_windows安装nodejs-优快云博客

四、使用mcp inspector调试服务

在命令行中执行命令：npx @modelcontextprotocol/inspector -e YML=D:\soft\anaconda3\envs\xiyan\Lib\site-packages\xiyan_mcp_server\config_demo.yml D:\soft\anaconda3\envs\xiyan\python -m xiyan_mcp_server

其中：

• YML=D:\soft\anaconda3\envs\xiyan\Lib\site-packages\xiyan_mcp_server\config_demo.yml是配置文件
• D:\soft\anaconda3\envs\xiyan\python是python环境

如果在config_demo.yml文件中配置了参数信息，在此处可以不指定配置文件

用浏览器打开上图位置的链接，每次执行可能不一样

按照下图依次操作，最后报错了，没找到原因，最后放弃了。

五、cherry studio配置xiyan_mcp_server

5.1、stdio方式配置

1、打开cherry studio工具的MCP配置页面

2、配置MCP

依次填写信息。如果没有把python添加到环境变量中，3处需要填写python工具所在的绝对路径。填写完成后，点击5处测试连接按钮。

连接成功后，按钮变为绿色

如果失败会弹出提示信息，检查配置信息是否有问题

3、测试功能

在模型中选择xiyan_mcp_server，连接数据库查询数据

注意：要在魔塔官网中绑定阿里云账号，否则在执行时会报，需要绑定阿里云账号的错误

5.2、sse方式配置

1、以sse方式启动xiyan MCP服务器，命令：uv run -m xiyan_mcp_server.server sse

2、在浏览器中测试是否可以访问xiyan MCP服务器，如下图表示成功，url：http://127.0.0.1:8000/sse

3、配置MCP

4、测试功能

六、xiyan_mcp_server源码

对源代码感兴趣的小伙伴，可以从git上下载源码，下载地址：

 gitcode代码：GitCode - 全球开发者的开源社区,开源代码托管平台

github代码：https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/README_zh.md

我是用的是pycharm，可以根据自己的情况选择IDE

1、安装包管理工具uv

2、下载依赖

3、修改配置信息

根据自己情况修改

4、以stdio方式启动MCP服务

5、以sse方式启动程序服务

参考资料：

MCP与数据库查询_xiyan-mcp-server-优快云博客

xiyan_mcp_server：自然语言查询数据库的利器-优快云博客

node工具安装：windows下安装并使用node.js_windows安装nodejs-优快云博客

cherry studio工具配置MPC：https://zhuanlan.zhihu.com/p/1903032315157930212

gitcode代码：GitCode - 全球开发者的开源社区,开源代码托管平台

github代码：https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/README_zh.md