🚀 xiyan-mcp-server 使用指南

本项目提供了 xiyan-mcp-server 的使用说明，涵盖模型配置、数据库配置、不同应用的启动方式等内容，帮助用户快速上手使用该服务。

🚀 快速开始

模型配置

执行以下命令进行模型配置：

python local_xiyan_server.py

📦 安装指南

数据库配置

MySQL

可按照以下配置示例对 MySQL 数据库进行配置：

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

PostgreSQL

若使用 PostgreSQL 数据库，需先安装 Python 包：

pip install psycopg2

💻 使用示例

启动方式

Claude Desktop

在 Claude Desktop 配置文件中添加以下内容，可参考claude_desktop.jpg：

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

⚠️ 重要提示

这里的 Python 命令需要完整的可执行路径（例如 /xxx/python），否则无法找到 Python 解释器。其他应用程序也是如此。

Cline

准备配置文件时，可参考Claude Desktop。

Goose

在配置中添加以下内容，可参考goose.jpg：

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

引用

如果发现我们的工作对你有帮助，请随意引用：

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