Xgenerationlab Xiyan MCP Server

🚀 xiyan_mcp_server

xiyan_mcp_server 是一個用於運行 XiYan - SQL 模型的服務器端工具，該模型可將自然語言轉換為結構化查詢語言（SQL）。本文檔將詳細指導您如何配置和運行此服務器。

🚀 快速開始

本部分將為您介紹如何快速配置並啟動 xiyan_mcp_server 服務器。

✨ 主要特性

• 支持多種遠程模型，方便靈活選擇。
• 支持本地模型運行，滿足不同使用場景。
• 可在多種環境（Claude 桌面、命令行 Goose、Cursor、Witsy）下啟動。

📦 安裝指南

本地模型安裝步驟

如果您希望在本地運行模型，請按照以下步驟操作：

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 路徑

📚 詳細文檔

模型配置

遠程模型

我們支持以下幾種遠程模型：

1. 模型名稱：xiyansql - qwencoder - 3b
   • 推薦使用此版本，因為它在性能上表現出色。
2. 模型名稱：xiyansql - qwencoder - 3b

📄 許可證

文檔中未提及相關許可證信息。

⚠️ 重要提示

在運行服務器之前，請確保所有配置信息正確無誤，並且數據庫服務已啟動。

💡 使用建議

推薦使用 xiyansql - qwencoder - 3b 模型，它在性能上表現出色。在本地運行模型時，請確保滿足硬件要求。