XiYanSQL (MySQL)

🚀 xiyan_mcp_server 使用说明

xiyan_mcp_server 是一个特定的服务器应用，本说明将指导你完成服务器的配置、启动以及工具集成等操作，帮助你顺利使用该项目。

🚀 快速开始

服务器配置

环境准备

请确保已安装 Python 和所需的依赖项。

配置文件示例

model:
  name: "xiyansql-qwe"
  key: "KEY"
  url: "http://localhost:5090"

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

启动命令

python local_xiyan_server.py

数据库配置

MySQL 配置示例

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

PostgreSQL 配置步骤

1. 安装依赖：

pip install psycopg2

2. 配置文件示例：

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

启动方式

使用 Claude Desktop

在配置文件中添加以下内容：

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

使用命令行

准备配置文件并运行：

python -m xiyan_mcp_server

💻 使用示例

工具集成示例

Goose 配置示例

在配置中添加以下内容：

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

Witsy 配置示例

添加以下内容到命令中：

/xxx/python -m xiyan_mcp_server

并设置环境变量：

YML=path/to/yml

📚 详细文档

问题反馈

如遇任何问题，请联系： 钉钉群｜ 微博关注

引用说明

如您使用本项目，请引用以下文献：

@article{xiyansql,
      title={A Preview of XiYan-SQL: A Multi-Generator Ensemble Framework for Text-to-SQL}, 
      author={Yingqi Gao and Yifu Liu and Xiaoxia Li and Xiaorong Shi and Yin Zhu and Yiming Wang and Shiqi Li and Wei Li and Yuntao Hong and Zhiling Luo and Jinyang Gao and Liyu Mou and Yu Li},
      year={2024},
      journal={arXiv preprint arXiv:2411.08599},
      url={https://arxiv.org/abs/2411.08599},
      primaryClass={cs.AI}
}