update readme

Author: XGenerationLab

README.md

@@ -6,7 +6,7 @@
 
 [![smithery badge](https://smithery.ai/badge/@XGenerationLab/xiyan_mcp_server)](https://smithery.ai/server/@XGenerationLab/xiyan_mcp_server)
 
-[English](https://github.com/XGenerationLab/xiyan_mcp_server)  | [中文](https://github.com/XGenerationLab/xiyan_mcp_server/README_zh.md)
+[English](https://github.com/XGenerationLab/xiyan_mcp_server)  | [中文](https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/README_zh.md)
 
 
 # XiYan MCP Server
@@ -16,14 +16,19 @@ A Model Context Protocol (MCP) server that enables natural language queries to d
 
 We support MySQL database now and more dialects are coming soon.
 
-## Features
+## 1. Features
 - Fetch data by natural language through [XiYanSQL](https://github.com/XGenerationLab/XiYan-SQL)
 - List available MySQL tables as resources
 - Read table contents
 
+## 2. Tool Preview
+ - The tool ``get_data_via_natural_language`` provides a natural language interface for retrieving data from a database. This server will convert the input natural language into SQL using a built-in model and call the database to return the query results.
 
+ - The ``mysql://{table_name}`` resource allows obtaining a portion of sample data from the database for model reference when a specific table_name is specified.
+- The ``mysql://`` resource will list the names of the current databases
 
-## Installation
+## 3. Installation
+### 3.1 Install from pip
 
 Python 3.11+ is required. 
 you can install the server through pip, and it will install the latest verion
@@ -43,7 +48,12 @@ env YML=path/to/yml python -m xiyan-mcp-server
 ```
 
 
-## Configuration
+### 3.2 Install from Smithery.ai
+See [@XGenerationLab/xiyan_mcp_server](https://smithery.ai/server/@XGenerationLab/xiyan_mcp_server)
+
+Not fully tested.
+
+## 4. Configuration
 
 You need a yml config file to configure the server.
 a default config file is provided in config_demo.yml which looks like this:
@@ -62,7 +72,7 @@ database:
   database: ""
 ```
 
-### About LLM
+### 4.1 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. We support following models.
 #### Using general LLMs
 if you want to use the general LLMs, e.g. gpt3.5, you can directly config like this:
@@ -97,7 +107,7 @@ database:
 #### Local LLMs
 To support in the future.
 
-### About the database
+### 4.2 About the database
 ``host``, ``port``, ``user``, ``password``, ``database`` are the connection information of the MySQL database.
 
 You can use local or any remote databases. Now we support MySQL (more dialects soon).
@@ -113,7 +123,7 @@ database:
 ```
 
 
-## Citation
+## 5. Citation
 If you find our work helpful, feel free to give us a cite.
 ```bib
 @article{xiyansql,

README_zh.md

@@ -1,24 +1,35 @@
+以下是您提供的文本的中文翻译：
+
+---
+
 [💻 XiYan-mcp-server](https://github.com/XGenerationLab/xiyan_mcp_server) | 
 [💻 XiYan-SQL](https://github.com/XGenerationLab/XiYan-SQL) |
 [📖 Arxiv](https://arxiv.org/abs/2411.08599) | 
 [📄 PapersWithCode](https://paperswithcode.com/paper/xiyan-sql-a-multi-generator-ensemble)
 
 [![smithery badge](https://smithery.ai/badge/@XGenerationLab/xiyan_mcp_server)](https://smithery.ai/server/@XGenerationLab/xiyan_mcp_server)
 
-[English](https://github.com/XGenerationLab/xiyan_mcp_server)  | [中文](https://github.com/XGenerationLab/xiyan_mcp_server/README_zh.md)
+[English](https://github.com/XGenerationLab/xiyan_mcp_server)  | [中文](https://github.com/XGenerationLab/xiyan_mcp_server/blob/main/README_zh.md)
 
 # XiYan MCP 服务器
 
 一个模型上下文协议（MCP）服务器，支持通过自然语言查询数据库，使用 [XiYanSQL](https://github.com/XGenerationLab/XiYan-SQL) 作为文本到 SQL 的技术。
 
 我们目前支持 MySQL 数据库，更多方言即将推出。
 
-## 特性
+## 1. 特性
 - 通过 [XiYanSQL](https://github.com/XGenerationLab/XiYan-SQL) 以自然语言获取数据
 - 列出可用的 MySQL 表作为资源
 - 读取表内容
 
-## 安装
+## 2. 工具预览
+- 工具 ``get_data_via_natural_language`` 提供了一个自然语言接口，从数据库中检索数据。该服务器将输入的自然语言转换为 SQL，并调用数据库返回查询结果。
+
+- ``mysql://{table_name}`` 资源允许在指定特定 `table_name` 的情况下，从数据库中获取部分样本数据，以供模型参考。
+- ``mysql://`` 资源将列出当前数据库的名称。
+
+## 3. 安装
+### 3.1 从 pip 安装
 
 需要 Python 3.11 或更高版本。 
 您可以通过 pip 安装该服务器，它将安装最新版本。
@@ -31,12 +42,17 @@ pip install xiyan-mcp-server
 ```bash
 python -m xiyan-mcp-server
 ```
-但在完成以下配置之前，它将不提供任何功能。您将获得一个 yml 文件。之后，您可以通过以下方式运行服务器：
+但是在完成以下配置之前，它不会提供任何功能。您将获得一个 yml 文件。之后，您可以通过以下方式运行服务器：
 ```yaml
 env YML=path/to/yml python -m xiyan-mcp-server
 ```
 
-## 配置
+### 3.2 从 Smithery.ai 安装
+查看 [@XGenerationLab/xiyan_mcp_server](https://smithery.ai/server/@XGenerationLab/xiyan_mcp_server)
+
+未进行全面测试。
+
+## 4. 配置
 
 您需要一个 yml 配置文件来配置服务器。
 默认配置文件在 `config_demo.yml` 中提供，其内容如下：
@@ -55,7 +71,7 @@ database:
   database: ""
 ```
 
-### 关于 LLM
+### 4.1 关于 LLM
 ``Name`` 是要使用的模型名称，``key`` 是模型的 API 密钥，``url`` 是模型的 API 地址。我们支持以下模型。
 #### 使用通用 LLM
 如果您想使用通用 LLM，例如 gpt3.5，您可以直接如下配置：
@@ -75,9 +91,8 @@ model:
   url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
 database:
 ```
-
 #### 使用文本到 SQL 的 SOTA 模型
-最后，我们推荐使用 XiYanSQL-qwencoder-32B (https://github.com/XGenerationLab/XiYanSQL-QwenCoder)，这是text-to-SQL 的 SOTA 模型。
+最后，我们推荐使用 XiYanSQL-qwencoder-32B (https://github.com/XGenerationLab/XiYanSQL-QwenCoder)，这是文本到 SQL 的 SOTA 模型。
 我们将模型部署在 DashScope 上，因此您需要设置以下环境变量：
 请联系我们以获取 ``key``。
 ```yaml
@@ -89,10 +104,9 @@ database:
 ```
 
 #### 本地 LLM
-
 未来将支持。
 
-### 关于数据库
+### 4.2 关于数据库
 ``host``, ``port``, ``user``, ``password``, ``database`` 是 MySQL 数据库的连接信息。
 
 您可以使用本地或任何远程数据库。现在我们支持 MySQL（即将支持更多方言）。
@@ -106,7 +120,7 @@ database:
   database: ""
 ```
 
-## 引用
+## 5. 引用
 如果您觉得我们的工作有帮助，请随意引用我们。
 ```bib
 @article{xiyansql,