Xgenerationlab Xiyan MCP Server

🚀 xiyan_mcp_server

xiyan_mcp_server は、XiYan - SQL モデルを実行するためのサーバーサイドツールです。このモデルは主に自然言語を構造化クエリ言語（SQL）に変換するために使用されます。このドキュメントでは、このサーバーの設定と実行方法を案内します。

🚀 クイックスタート

このセクションでは、xiyan_mcp_server のクイックスタート方法を説明します。まずはモデルとデータベースの設定を行い、その後サーバーを起動します。

✨ 主な機能

• XiYan - SQL モデルをサポートし、自然言語を SQL に変換します。
• リモートモデルとローカルモデルの両方をサポートします。

📦 インストール

モデル設定

リモートモデル

以下のリモートモデルをサポートしています。

1. モデル名: xiyansql-qwencoder-3b
   • 性能が優れているため、このバージョンの使用をおすすめします。
2. モデル名: xiyansql-qwencoder-3b

ローカルモデル

モデルをローカルで実行する場合は、以下の手順に従ってください。

1. ハードウェア要件:

   • CPU: 少なくとも 16GB のメモリ
   • ストレージ容量: 少なくとも 6GB の空き容量

2. 依存関係のインストール：

pip install flask modelscope torch==2.2.2 accelerate>=0.26.0 numpy=2.2.3

3. モデルのダウンロード（オプション）：
   • xiyansql-qwencoder-3b モデルのダウンロードをおすすめします。

modelscope download --model XGenerationLab/XiYanSQL-QwenCoder-3B-2502

4. サーバーの起動：

python local_xiyan_server.py

サーバーは http://localhost:5090/ で実行されます。

設定例

設定ファイル（config.yml）は以下のようになります。

model:
  name: "xiyansql-qwencoder-3b"
  key: "KEY" # あなたのキーに置き換えてください
  url: "http://127.0.0.1:5090"

データベース設定

以下はデータベースの接続情報です。

database:
  host: "localhost" # データベースのアドレス
  port: 3306       # データベースのポート
  user: "root"     # データベースのユーザー名
  password: ""      # データベースのパスワード
  database: ""      # データベースの名前

🔧 起動方法

Claude デスクトップでの起動

Claude デスクトップ設定ファイルに以下の内容を追加してください。

{
    "mcpServers": {
        "xiyan-mcp-server": {
            "command": "python",
            "args": [
                "-m",
                "xiyan_mcp_server"
            ],
            "env": {
                "YML": "PATH/TO/YML" # あなたの config.yml のパスに置き換えてください
            }
        }
    }
}

コマンドライン（Goose）での起動

設定ファイルに以下の内容を追加してください。

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

Cursor での起動

Goose と同じ方法を使用してください。

Witsy での起動

コマンドに以下を追加してください。

python -m xiyan_mcp_server

そして、環境変数を設定してください。

• 変数名: YML
• 変数値: あなたの config.yml のパス

📚 トラブルシューティング

問題が発生した場合は、以下の方法で支援を求めてください。

GitHub リポジトリ

⚠️ 重要提示

サーバーを起動する前に、すべての設定情報が正しいことと、データベースサービスが起動していることを確認してください。