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