feat: 更新 Dockerfile 并完善 README

- 将 Dockerfile 中的 Python 版本从 3.9 升级到 3.11
- 重构 README.md，增加配置说明和使用示例
- 新增 setup.py 文件，定义项目依赖和元数据- 更新 smithery.yaml，修改 MCP 启动命令

Author: XGenerationLab

Dockerfile

@@ -1,5 +1,5 @@
 # 使用Python 3.9作为基础镜像
-FROM python:3.9-slim
+FROM python:3.11-slim
 
 # 设置工作目录
 WORKDIR /app

README.md

@@ -2,7 +2,7 @@
 
 # XiYan MCP Server
 
-A Model Context Protocol (MCP) server that enables natural language queries to MySQL databases, power by XiYanSQL as text-to-sql technique.
+A Model Context Protocol (MCP) server that enables natural language queries to MySQL databases, power by XiYanSQL(https://github.com/XGenerationLab/XiYan-SQL) as text-to-sql technique.
 
 
 ## Features
@@ -12,74 +12,102 @@ A Model Context Protocol (MCP) server that enables natural language queries to M
 
 ## Installation
 
-Python 3.11+ is required.
+Python 3.11+ is required. 
+you can install the server by a pre-release verion
 
 ```bash
-pip install xiyan-mcp-server
+pip install xiyan_mcp_server-0.1.0-py3-none-any
 ```
 
-## Configuration
-
-Set the following environment variables:
-
+After that you can directly run the server by:
 ```bash
-YML=    # yml config file path
+python -m xiyan_mcp_server
+```
+But it does not provide any functions until you complete following config.
+You will get a yml file. After that you can run the server by:
+```yaml
+env YML=path/to/yml python -m xiyan_mcp_server
 ```
 
-see config_demo.yml for example
-
-## Models
-
-Any LLMs are supported as long as they support the `chat` API. 
-We recommend using xiyansql-qwencoder-32b (https://github.com/XGenerationLab/XiYanSQL-QwenCoder) for best performance.
 
-## Usage
+## Configuration
 
-### With Claude Desktop
+You need a yml config file to configure the server.
+a default config file is provided in config_demo.yml which looks like this:
+
+```yaml
+model:
+  name: "pre-xiyan_multi_dialect_v3"
+  key: ""
+  url: "https://poc-dashscope.aliyuncs.com/compatible-mode/v1"
+
+database:
+  host: "localhost"
+  port: 3306
+  user: "root"
+  password: ""
+  database: ""
+```
 
-Add this to your `claude_desktop_config.json`:
+### About LLM
+Name is the name of the model to use, key is the API key of the model, url is the API url of the model. 
+#### Using general LLMs
+if you want to use the general LLMs, e.g. gpt3.5, you can directly config like this:
+```yaml
+model:
+  name: "gpt-3.5-turbo"
+  key: "YOUR KEY "
+  url: "https://api.openai.com/v1/chat/completions"
+database:
+```
 
-```json
-{
-  "mcpServers": {
-    "xiyan": {
-      "command": "uv",
-      "args": [
-        "--directory", 
-        "path/to/xiyan_mcp_server",
-        "run",
-        "xiyan_mcp_server"
-      ],
-      "env": {
-        "YML": "path/to/yml"
-      }
-    }
-  }
-}
+if you want to use Qwen from alibaba, e.g. Qwen-max,
+```yaml
+model:
+  name: "qwen-max"
+  key: "YOUR KEY "
+  url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
+database:
+```
+#### Using Text-to-SQL SOTA model
+Last, we recommend the XiYanSQL-qwencoder-32B (https://github.com/XGenerationLab/XiYanSQL-QwenCoder), which is the SOTA model in text-to-sql.
+We deployed the model on DashScope, so you need to set the following environment variables:
+Contact us to get the key.
+```yaml
+model:
+  name: "pre-xiyan_multi_dialect_v3"
+  key: "KEY"
+  url: "https://poc-dashscope.aliyuncs.com/compatible-mode/v1"
+database:
 ```
 
-### As a standalone server
+#### Local LLMs
+To support in the future.
 
-```bash
-# Install dependencies
-pip install -r requirements.txt
+### About the database
+host, port, user, password, database are the connection information of the MySQL database.
 
-# Run the server
-python -m xiyan_mcp_server
+You can use local or any remote databases. Currently we support MySQL (more dialects soon)
+```yaml
+database:
+  host: "localhost"
+  port: 3306
+  user: "root"
+  password: ""
+  database: ""
 ```
 
-## Development
-
-```bash
-# Clone the repository
-git clone https://github.com/XGenerationLab/xiyan_mcp_server.git
-cd xiyan_mcp_server
-
-# Create virtual environment
-python -m venv venv
-source venv/bin/activate  # or `venv\Scripts\activate` on Windows
+## Citation
+If you find our work helpful, feel free to give us a cite.
+```bib
+@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}
+}
+```
 
-# Install development dependencies
-pip install -r requirements.txt
 
-```

setup.py

@@ -0,0 +1,28 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='xiyan_mcp_server',  # 包的名字
+    version='0.1.0',  # 版本号
+    packages=find_packages(),  # 自动找到项目中的包
+    install_requires=[  # 必要的包依赖
+        # 'numpy',  # 示例：若有依赖包，将其列在此
+'mcp',
+'mysql-connector-python>=9.1.0',
+'sqlalchemy',
+'llama_index',
+'yaml',
+'pandas'
+    ],
+    author='Bruce Luo',  # 作者
+    author_email='godot.lzl@alibaba-inc.com',  # 作者邮箱
+    description='A MCP server of natural language interface to Database',  # 简短描述
+    long_description=open('README.md').read(),  # 从 README 文件读取详细描述
+    long_description_content_type='text/markdown',  # 描述内容类型
+    url='https://github.com/XGenerationLab/xiyan_mcp_server',  # 项目主页
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.11',  # 支持的 Python 版本
+)

smithery.yaml

@@ -8,9 +8,10 @@ startCommand:
     # A function that produces the CLI command to start the MCP on stdio.
     |-
     (config) => ({
-      "command": "node",
+      "command": "python",
       "args": [
-        "dist/index.js"
+        "-m",
+        "xiyan-mcp-server"
       ],
       "env": {
       }