Skip to content

Commit 42540f9

Browse files
update readme
1 parent cf5bdeb commit 42540f9

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1+
2+
[💻 XiYan-mcp-server](https://github.com/XGenerationLab/xiyan_mcp_server) |
3+
[💻 XiYan-SQL](https://github.com/XGenerationLab/XiYan-SQL) |
4+
[📖 Arxiv](https://arxiv.org/abs/2411.08599)|
5+
[📄 PapersWithCode](https://paperswithcode.com/paper/xiyan-sql-a-multi-generator-ensemble)
6+
17
[![smithery badge](https://smithery.ai/badge/@XGenerationLab/xiyan_mcp_server)](https://smithery.ai/server/@XGenerationLab/xiyan_mcp_server)
28

39
# XiYan MCP Server
410

5-
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.
611

12+
A Model Context Protocol (MCP) server that enables natural language queries to databases, power by XiYanSQL(https://github.com/XGenerationLab/XiYan-SQL) as text-to-sql technique.
13+
14+
We support MySQL database now and more dialects are coming soon.
715

816
## Features
9-
- Fetch data by natural language throught XiYanSQL (https://github.com/XGenerationLab/XiYan-SQL)
17+
- Fetch data by natural language through XiYanSQL (https://github.com/XGenerationLab/XiYan-SQL)
1018
- List available MySQL tables as resources
1119
- Read table contents
1220

@@ -16,7 +24,7 @@ Python 3.11+ is required.
1624
you can install the server by a pre-release verion
1725

1826
```bash
19-
pip install xiyan_mcp_server-0.1.0-py3-none-any.whl
27+
pip install xiyan_mcp_server
2028
```
2129

2230
After that you can directly run the server by:

pyproject.toml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
[project]
22
name = "xiyan_mcp_server"
3-
version = "0.1.0"
4-
description = "A Model Context Protocol (MCP) server that using XiyanSQL with MySQL databases. This server allows AI assistants to list tables, read data, and execute natual language queries."
3+
version = "0.1.1"
4+
description = "A Model Context Protocol (MCP) server that utilizes XiyanSQL with databases. This server enables AI assistants to list tables, read data, and execute natural language queries"
55
readme = "README.md"
66
requires-python = ">=3.11"
77
dependencies = [
88
"mcp>=1.0.0",
99
"mysql-connector-python>=9.1.0",
1010
"llama_index",
11-
"sqlalchemy"
11+
"sqlalchemy",
12+
"pymysql"
1213
]
1314
[[project.authors]]
1415
name = "Zhiling Luo"

0 commit comments

Comments
 (0)