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