You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-5Lines changed: 7 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
# XiYan MCP Server
13
13
14
14
15
-
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.
15
+
A Model Context Protocol (MCP) server that enables natural language queries to databases, powered by [XiYanSQL](https://github.com/XGenerationLab/XiYan-SQL) as text-to-sql technique.
16
16
17
17
We support MySQL database now and more dialects are coming soon.
18
18
@@ -39,12 +39,12 @@ pip install xiyan-mcp-server
39
39
40
40
After that you can directly run the server by:
41
41
```bash
42
-
python -m xiyan-mcp-server
42
+
python -m xiyan_mcp_server
43
43
```
44
44
But it does not provide any functions until you complete following config.
45
45
You will get a yml file. After that you can run the server by:
46
46
```yaml
47
-
env YML=path/to/yml python -m xiyan-mcp-server
47
+
env YML=path/to/yml python -m xiyan_mcp_server
48
48
```
49
49
50
50
@@ -94,8 +94,8 @@ database:
94
94
```
95
95
#### Using Text-to-SQL SOTA model
96
96
Last, we recommend the XiYanSQL-qwencoder-32B (https://github.com/XGenerationLab/XiYanSQL-QwenCoder), which is the SOTA model in text-to-sql.
97
-
We deployed the model on DashScope, so you need to set the following environment variables:
98
-
Contact us to get the ``key``.
97
+
We deployed the model on Alibaba Cloud DashScope, so you need to set the following environment variables:
98
+
Contact us to get the ``key``. ( godot.lzl@alibaba-inc.com )
99
99
```yaml
100
100
model:
101
101
name: "pre-xiyan_multi_dialect_v3"
@@ -104,6 +104,8 @@ model:
104
104
database:
105
105
```
106
106
107
+
Alternatively, you can also deploy the model (XiYanSQL-qwencoder-32B) on your own server.
0 commit comments