Skip to content

Commit 8466a06

Browse files
update readme
1 parent 4dfb76a commit 8466a06

File tree

2 files changed

+142
-84
lines changed

2 files changed

+142
-84
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
🤖 <a href="https://modelscope.cn/collections/XiYanSQL-Models-4483337b614241" >ModelScope</a> |
1717
🌕 <a href="https://bailian.console.aliyun.com/xiyan">析言GBI</a>
1818
<br />
19+
<img src="https://badge.mcpx.dev/?type=server%20%27MCP%20Server%27" alt="MCP Server" />
1920
<a href="https://arxiv.org/abs/2411.08599"><img src="imgs/Paper-Arxiv-orange.svg" ></a>
2021
<a href="https://opensource.org/licenses/Apache-2.0">
2122
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0" />
@@ -71,13 +72,19 @@
7172
### Architecture
7273
There are two ways to integrate this server in your project, as shown below:
7374
The left is remote mode, which is the default mode. It requires an API key to access the xiyanSQL-qwencoder-32B model from service provider (see [Configuration](#Configuration)).
74-
Another mode is local mode, which is more secure. It does not require an API key.
75+
Another mode is local mode, which is more secure. It does not require the API key.
7576

7677
![architecture.png](imgs/architecture.png)
77-
### Best practice
78+
### Best practice and reports
7879

79-
[Build a local data assistant using MCP + Modelscope API-Inference without writing a single line of code](https://mp.weixin.qq.com/s/tzDelu0W4w6t9C0_yYRbHA)
80+
["Build a local data assistant using MCP + Modelscope API-Inference without writing a single line of code"](https://mp.weixin.qq.com/s/tzDelu0W4w6t9C0_yYRbHA)
8081

82+
["Xiyan MCP on Modelscope"](https://modelscope.cn/headlines/article/1142)
83+
84+
### Evaluation on MCPBench
85+
The following figure illustrates the performance of the XiYan MCP server as measured by the MCPBench benchmark. The XiYan MCP server demonstrates superior performance compared to both the MySQL MCP server and the PostgreSQL MCP server, achieving a lead of 2-22 percentage points. The detailed experiment results can be found at [MCPBench](https://github.com/modelscope/MCPBench) and the report ["Evaluation Report on MCP Servers"](https://arxiv.org/abs/2504.11094).
86+
87+
![exp_mcpbench.png](imgs/exp_mcpbench.png)
8188

8289
### Tools Preview
8390
- The tool ``get_data`` 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.

0 commit comments

Comments
 (0)