🚀 xiyan_mcp_server
xiyan_mcp_server 是一个用于运行 XiYan - SQL 模型的服务器端工具，该模型可将自然语言转换为结构化查询语言（SQL）。本文档将详细指导您如何配置和运行此服务器。
🚀 快速开始
本部分将为您介绍如何快速配置并启动 xiyan_mcp_server 服务器。
✨ 主要特性
- 支持多种远程模型，方便灵活选择。
- 支持本地模型运行，满足不同使用场景。
- 可在多种环境（Claude 桌面、命令行 Goose、Cursor、Witsy）下启动。
📦 安装指南
本地模型安装步骤
如果您希望在本地运行模型，请按照以下步骤操作：
- 硬件要求：
- CPU：至少 16GB 内存。
- 存储空间：至少 6GB 可用空间。
- 安装依赖项：
pip install flask modelscope torch==2.2.2 accelerate>=0.26.0 numpy=2.2.3
- 下载模型（可选）：
建议下载
xiyansql - qwencoder - 3b模型。
modelscope download --model XGenerationLab/XiYanSQL - QwenCoder - 3B - 2502
- 运行服务器：
python local_xiyan_server.py
服务器将在 http://localhost:5090/ 上运行。
配置示例
您的配置文件（config.yml）应如下所示：
model:
name: "xiyansql-qwencoder-3b"
key: "KEY" # 替换为您的密钥
url: "http://127.0.0.1:5090"
数据库配置
以下是数据库的连接信息：
database:
host: "localhost" # 数据库地址
port: 3306 # 数据库端口
user: "root" # 数据库用户名
password: "" # 数据库密码
database: "" # 数据库名称
💻 使用示例
启动方法
在 Claude 桌面
将以下内容添加到您的 Claude 桌面配置文件中：
{
"mcpServers": {
"xiyan-mcp-server": {
"command": "python",
"args": [
"-m",
"xiyan_mcp_server"
],
"env": {
"YML": "PATH/TO/YML" # 替换为您的 config.yml 路径
}
}
}
}
在命令行（Goose）
在配置文件中添加以下内容：
env YML=path/to/yml python -m xiyan_mcp_server
在 Cursor
使用与 Goose 相同的方法。
在 Witsy
在命令中添加：
python -m xiyan_mcp_server
并设置环境变量：
- 变量名:
YML - 变量值: 您的 config.yml 路径
📚 详细文档
模型配置
远程模型
我们支持以下几种远程模型：
- 模型名称：
xiyansql - qwencoder - 3b- 推荐使用此版本，因为它在性能上表现出色。
- 模型名称：
xiyansql - qwencoder - 3b
📄 许可证
文档中未提及相关许可证信息。
⚠️ 重要提示
在运行服务器之前，请确保所有配置信息正确无误，并且数据库服务已启动。
💡 使用建议
推荐使用
xiyansql - qwencoder - 3b模型，它在性能上表现出色。在本地运行模型时，请确保满足硬件要求。