XiYan MCP Server

XiYan MCP Server

site icon
2025.04.17 83000
Python数据库查询自然语言处理开发工具数据库开发效率
XiYan MCP Server 可以通过自然语言查询数据库。它由XiYan-SQL驱动,在开放基准测试中表现出色。该服务器支持多种模型,包括通用LLMs(如GPT、qwenmax)和Text-to-SQL的SOTA模型,并支持纯本地模式(高安全性)。此外,它还支持MySQL和PostgreSQL数据库,并提供了多种工具来简化数据库查询和管理。
View on GitHub

Overview

基本能力

产品定位

XiYan MCP Server 是一个通过自然语言查询数据库的服务,旨在简化数据库操作,提高开发效率。

核心功能

  • 🌐 通过自然语言获取数据库数据
  • 🤖 支持通用LLMs(如GPT、qwenmax)和Text-to-SQL的SOTA模型
  • 💻 支持纯本地模式(高安全性)
  • 📝 支持MySQL和PostgreSQL数据库
  • 🖱️ 列出可用表作为资源
  • 🔧 读取表内容

适用场景

  • 开发人员需要快速查询数据库
  • 数据分析师需要简化SQL查询
  • 企业需要高安全性的本地数据库查询解决方案

工具列表

  • get_data:提供自然语言接口,从数据库中检索数据
  • {dialect}://{table_name}:获取数据库中指定表的部分样本数据
  • {dialect}://:列出当前数据库的名称

常见问题解答

  • 如果服务无法正常工作,可以通过钉钉群或微博联系开发者。

使用教程

使用依赖

Python 3.11+ 是必需的。

安装教程

通过pip安装最新版本:

pip install xiyan-mcp-server

运行服务器:

python -m xiyan_mcp_server

调试方式

在完成配置后,可以通过以下命令运行服务器:

env YML=path/to/yml python -m xiyan_mcp_server

本地模型安装

  1. 安装额外的Python包:
pip install flask modelscope torch==2.2.2 accelerate>=0.26.0 numpy=2.2.3
  1. 手动下载模型:
modelscope download --model XGenerationLab/XiYanSQL-QwenCoder-3B-2502
  1. 运行本地服务器:
python local_xiyan_server.py
  1. 准备配置文件并运行服务器:
model:
  name: "xiyansql-qwencoder-3b"
  key: "KEY"
  url: "http://127.0.0.1:5090"

数据库配置

MySQL

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: ""
  database: ""

PostgreSQL

  1. 安装Python包:
pip install psycopg2
  1. 准备配置文件:
database:
  dialect: "postgresql"
  host: "localhost"
  port: 5432
  user: ""
  password: ""
  database: ""

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。