Xiyan MCP Server

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